diff --git a/DESCRIPTION b/DESCRIPTION index c49f07f..3a4dadc 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -26,7 +26,6 @@ Imports: readr, pdftools, antiword -RoxygenNote: 7.2.3 Suggests: knitr, rmarkdown, @@ -37,5 +36,7 @@ Suggests: ggiraph, testthat (>= 3.0.0) URL: https://michalovadek.github.io/eurlex/ +RoxygenNote: 7.2.3 +Roxygen: list(markdown = TRUE) VignetteBuilder: knitr Config/testthat/edition: 3 diff --git a/NEWS.md b/NEWS.md index d274a05..eec75d0 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,9 @@ +# eurlex 0.4.6 + +## Minor changes + +- minor changes to documentation + # eurlex 0.4.5 ## Major changes diff --git a/R/elx_council_votes.R b/R/elx_council_votes.R index 9683b5e..7fff72f 100644 --- a/R/elx_council_votes.R +++ b/R/elx_council_votes.R @@ -99,5 +99,3 @@ elx_council_votes <- function(){ return(votes) } - - diff --git a/R/elx_fetch_data.R b/R/elx_fetch_data.R index 158f195..c3c9fb4 100644 --- a/R/elx_fetch_data.R +++ b/R/elx_fetch_data.R @@ -9,7 +9,7 @@ #' @param language_2 If data not available in `language_1`, try `language_2` #' @param language_3 If data not available in `language_2`, try `language_3` #' @param include_breaks If TRUE, text includes tags showing where pages ("---pagebreak---", for pdfs) and documents ("---documentbreak---") were concatenated -#' @param html_text Choose whether to read text from html using `rvest::html_text2` ("text2") or `rvest::html_text` ("text") +#' @param html_text Choose whether to read text from html using [rvest::html_text2()] ("text2") or [rvest::html_text()] ("text") #' @return #' A character vector of length one containing the result. When `type = "text"`, named character vector where the name contains the source of the text. #' @export diff --git a/R/elx_run_query.R b/R/elx_run_query.R index a36d7d1..ee4144a 100644 --- a/R/elx_run_query.R +++ b/R/elx_run_query.R @@ -4,7 +4,7 @@ #' Relies on elx_make_query to generate valid SPARQL queries. #' Results are capped at 1 million rows. #' -#' @param query A valid SPARQL query specified by `elx_make_query()` or manually +#' @param query A valid SPARQL query specified by [elx_make_query()] or manually #' @param endpoint SPARQL endpoint #' @return #' A data frame containing the results of the SPARQL query. diff --git a/docs/articles/council.html b/docs/articles/council.html index ae0af23..57806cd 100644 --- a/docs/articles/council.html +++ b/docs/articles/council.html @@ -218,8 +218,8 @@

Interactive plot opts_hover_inv(css = "opacity:0.1;"), opts_hover(css = "fill:green;")) ) -
-

The country comparison reveals substantial variation in the frequency +

+

The country comparison reveals substantial variation in the frequency of disagreement. The only Member State to ever exit the EU, the United Kingdom, was particularly active when it comes to abstaining or voting against legislation. On the other end of the scale is France, which has diff --git a/docs/articles/eurlexpkg_files/figure-html/wordcloud-1.png b/docs/articles/eurlexpkg_files/figure-html/wordcloud-1.png index cf77d8c..d15b00b 100644 Binary files a/docs/articles/eurlexpkg_files/figure-html/wordcloud-1.png and b/docs/articles/eurlexpkg_files/figure-html/wordcloud-1.png differ diff --git a/docs/authors.html b/docs/authors.html index c37f4a8..2239af5 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -70,17 +70,19 @@

Citation

Ovadek M (2021). “Facilitating access to data on European Union laws.” -Political Research Exchange, 3. +Political Research Exchange, 3(1), 1870150. doi:10.1080/2474736X.2020.1870150.

- 
@Article{,
+    
@Article{eurlex-package,
   title = {Facilitating access to data on European Union laws},
   author = {Michal Ovadek},
   year = {2021},
   journal = {Political Research Exchange},
   volume = {3},
-  issue = {1},
+  number = {1},
+  pages = {1870150},
   doi = {10.1080/2474736X.2020.1870150},
+  publisher = {Taylor & Francis},
 }

 
   
diff --git a/docs/news/index.html b/docs/news/index.html
index ada5279..49ba53b 100644
--- a/docs/news/index.html
+++ b/docs/news/index.html
@@ -55,7 +55,14 @@ 
Changelog 

     
 
     

-
eurlex 0.4.5

+
eurlex 0.4.6

+

+
Minor changes

+
  • minor changes to documentation
    • 
+

+

+    

+
eurlex 0.4.52023-08-21

 

 
Major changes

 
  • breaking change: elx_run_query() now strips URIs (except Eurovoc ones) by default and keeps only the identifier to reduce object size
    • 
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index 1203198..b577e95 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -4,5 +4,5 @@ pkgdown_sha: ~
 articles:
   council: council.html
   eurlexpkg: eurlexpkg.html
-last_built: 2023-08-21T13:47Z
+last_built: 2023-08-22T13:19Z
 
diff --git a/docs/reference/elx_curia_list.html b/docs/reference/elx_curia_list.html
index e5b4731..031932d 100644
--- a/docs/reference/elx_curia_list.html
+++ b/docs/reference/elx_curia_list.html
@@ -76,7 +76,7 @@ 
    Arguments
    
 
 
 
    parse
    
-
    If `TRUE`, references to cases and appeals are parsed out from `case_info` into separate columns
    
+
    If TRUE, references to cases and appeals are parsed out from case_info into separate columns
    
 
 

     

diff --git a/docs/reference/elx_download_xml.html b/docs/reference/elx_download_xml.html
index a0dd156..7684f6d 100644
--- a/docs/reference/elx_download_xml.html
+++ b/docs/reference/elx_download_xml.html
@@ -90,11 +90,11 @@ 
Arguments

 
 
 
language_2

-
If data not available in `language_1`, try `language_2`

+
If data not available in language_1, try language_2

 
 
 
language_3

-
If data not available in `language_2`, try `language_3`

+
If data not available in language_2, try language_3

 
 
 
mode

diff --git a/docs/reference/elx_fetch_data.html b/docs/reference/elx_fetch_data.html
index e41ef24..54f151f 100644
--- a/docs/reference/elx_fetch_data.html
+++ b/docs/reference/elx_fetch_data.html
@@ -91,11 +91,11 @@ 
Arguments

 
 
 
language_2

-
If data not available in `language_1`, try `language_2`

+
If data not available in language_1, try language_2

 
 
 
language_3

-
If data not available in `language_2`, try `language_3`

+
If data not available in language_2, try language_3

 
 
 
include_breaks

@@ -103,14 +103,14 @@ 
Arguments

 
 
 
html_text

-
Choose whether to read text from html using `rvest::html_text2` ("text2") or `rvest::html_text` ("text")

+
Choose whether to read text from html using rvest::html_text2() ("text2") or rvest::html_text() ("text")

 
 

     

     
Value

     
 
-
A character vector of length one containing the result. When `type = "text"`, named character vector where the name contains the source of the text.

+
A character vector of length one containing the result. When type = "text", named character vector where the name contains the source of the text.

     

 
     

diff --git a/docs/reference/elx_label_eurovoc.html b/docs/reference/elx_label_eurovoc.html
index 52f4960..c95ab58 100644
--- a/docs/reference/elx_label_eurovoc.html
+++ b/docs/reference/elx_label_eurovoc.html
@@ -70,7 +70,7 @@ 
Arguments

 
 
 
alt_labels

-
If `TRUE`, results include comma-separated alternative labels in addition to the preferred label

+
If TRUE, results include comma-separated alternative labels in addition to the preferred label

 
 
 
language

@@ -81,7 +81,7 @@ 
Arguments

     
Value

     
 
-
A `tibble` containing EuroVoc unique concept identifiers and labels.

+
A tibble containing EuroVoc unique concept identifiers and labels.

     

 
     

diff --git a/docs/reference/elx_make_query.html b/docs/reference/elx_make_query.html
index 191d34d..f3e61ac 100644
--- a/docs/reference/elx_make_query.html
+++ b/docs/reference/elx_make_query.html
@@ -119,103 +119,103 @@ 
Arguments

 
 
 
include_corrigenda

-
If `TRUE`, results include corrigenda

+
If TRUE, results include corrigenda

 
 
 
include_celex

-
If `TRUE`, results include CELEX identifier for each resource URI

+
If TRUE, results include CELEX identifier for each resource URI

 
 
 
include_lbs

-
If `TRUE`, results include legal bases of legislation

+
If TRUE, results include legal bases of legislation

 
 
 
include_date

-
If `TRUE`, results include document date

+
If TRUE, results include document date

 
 
 
include_date_force

-
If `TRUE`, results include date of entry into force

+
If TRUE, results include date of entry into force

 
 
 
include_date_endvalid

-
If `TRUE`, results include date of end of validity

+
If TRUE, results include date of end of validity

 
 
 
include_date_transpos

-
If `TRUE`, results include date of transposition deadline for directives

+
If TRUE, results include date of transposition deadline for directives

 
 
 
include_date_lodged

-
If `TRUE`, results include date a court case was lodged with the court

+
If TRUE, results include date a court case was lodged with the court

 
 
 
include_force

-
If `TRUE`, results include whether legislation is in force

+
If TRUE, results include whether legislation is in force

 
 
 
include_eurovoc

-
If `TRUE`, results include EuroVoc descriptors of subject matter

+
If TRUE, results include EuroVoc descriptors of subject matter

 
 
 
include_citations

-
If `TRUE`, results include citations (CELEX-labelled)

+
If TRUE, results include citations (CELEX-labelled)

 
 
 
include_citations_detailed

-
If `TRUE`, results include citations (CELEX-labelled) with additional details

+
If TRUE, results include citations (CELEX-labelled) with additional details

 
 
 
include_author

-
If `TRUE`, results include document author(s)

+
If TRUE, results include document author(s)

 
 
 
include_directory

-
If `TRUE`, results include the label of the Eur-Lex directory code

+
If TRUE, results include the label of the Eur-Lex directory code

 
 
 
include_directory_code

-
If `TRUE`, results include the Eur-Lex directory code

+
If TRUE, results include the Eur-Lex directory code

 
 
 
include_sector

-
If `TRUE`, results include the Eur-Lex sector code

+
If TRUE, results include the Eur-Lex sector code

 
 
 
include_ecli

-
If `TRUE`, results include the ECLI identifier for court documents

+
If TRUE, results include the ECLI identifier for court documents

 
 
 
include_court_procedure

-
If `TRUE`, results include type of court procedure and outcome

+
If TRUE, results include type of court procedure and outcome

 
 
 
include_judge_rapporteur

-
If `TRUE`, results include the Judge-Rapporteur

+
If TRUE, results include the Judge-Rapporteur

 
 
 
include_advocate_general

-
If `TRUE`, results include the Advocate General

+
If TRUE, results include the Advocate General

 
 
 
include_court_formation

-
If `TRUE`, results include the court formation

+
If TRUE, results include the court formation

 
 
 
include_court_scholarship

-
If `TRUE`, results include court-curated relevant scholarship

+
If TRUE, results include court-curated relevant scholarship

 
 
 
include_court_origin

-
If `TRUE`, results include country of origin of court case

+
If TRUE, results include country of origin of court case

 
 
 
include_original_language

-
If `TRUE`, results include authentic language of document (usually case)

+
If TRUE, results include authentic language of document (usually case)

 
 
 
include_proposal

-
If `TRUE`, results include the CELEX of the proposal of the adopted legal act

+
If TRUE, results include the CELEX of the proposal of the adopted legal act

 
 
 
order

diff --git a/docs/reference/elx_run_query.html b/docs/reference/elx_run_query.html
index 88379a3..76fd7d8 100644
--- a/docs/reference/elx_run_query.html
+++ b/docs/reference/elx_run_query.html
@@ -73,7 +73,7 @@ 
Execute SPARQL queries

     

     
Arguments

     
query

-
A valid SPARQL query specified by `elx_make_query()` or manually

+
A valid SPARQL query specified by elx_make_query() or manually

 
 
 
endpoint

@@ -85,7 +85,7 @@ 
Value

     
 
 
A data frame containing the results of the SPARQL query.
-Column `work` contains the Cellar URI of the resource.

+Column work contains the Cellar URI of the resource.

     

 
     

diff --git a/man/elx_curia_list.Rd b/man/elx_curia_list.Rd
index 811e984..6f1cc84 100644
--- a/man/elx_curia_list.Rd
+++ b/man/elx_curia_list.Rd
@@ -13,7 +13,7 @@ elx_curia_list(
 \item{data}{Data to be scraped from four separate lists of cases maintained by Curia, defaults to "all"
 which contains cases from Court of Justice, General Court and Civil Service Tribunal.}
 
-\item{parse}{If `TRUE`, references to cases and appeals are parsed out from `case_info` into separate columns}
+\item{parse}{If \code{TRUE}, references to cases and appeals are parsed out from \code{case_info} into separate columns}
 }
 \value{
 A data frame containing case identifiers and information as character columns. Where the case id
diff --git a/man/elx_download_xml.Rd b/man/elx_download_xml.Rd
index 99cac73..2a57aec 100644
--- a/man/elx_download_xml.Rd
+++ b/man/elx_download_xml.Rd
@@ -23,9 +23,9 @@ elx_download_xml(
 
 \item{language_1}{The priority language in which the data will be attempted to be retrieved, in ISO 639 2-char code}
 
-\item{language_2}{If data not available in `language_1`, try `language_2`}
+\item{language_2}{If data not available in \code{language_1}, try \code{language_2}}
 
-\item{language_3}{If data not available in `language_2`, try `language_3`}
+\item{language_3}{If data not available in \code{language_2}, try \code{language_3}}
 
 \item{mode}{A character string specifying the mode with which to write the file. Useful values are "w", "wb" (binary), "a" (append) and "ab".}
 }
diff --git a/man/elx_fetch_data.Rd b/man/elx_fetch_data.Rd
index 9d4a84f..3a77090 100644
--- a/man/elx_fetch_data.Rd
+++ b/man/elx_fetch_data.Rd
@@ -24,16 +24,16 @@ elx_fetch_data(
 
 \item{language_1}{The priority language in which the data will be attempted to be retrieved, in ISO 639 2-char code}
 
-\item{language_2}{If data not available in `language_1`, try `language_2`}
+\item{language_2}{If data not available in \code{language_1}, try \code{language_2}}
 
-\item{language_3}{If data not available in `language_2`, try `language_3`}
+\item{language_3}{If data not available in \code{language_2}, try \code{language_3}}
 
 \item{include_breaks}{If TRUE, text includes tags showing where pages ("---pagebreak---", for pdfs) and documents ("---documentbreak---") were concatenated}
 
-\item{html_text}{Choose whether to read text from html using `rvest::html_text2` ("text2") or `rvest::html_text` ("text")}
+\item{html_text}{Choose whether to read text from html using \code{\link[rvest:html_text]{rvest::html_text2()}} ("text2") or \code{\link[rvest:html_text]{rvest::html_text()}} ("text")}
 }
 \value{
-A character vector of length one containing the result. When `type = "text"`, named character vector where the name contains the source of the text.
+A character vector of length one containing the result. When \code{type = "text"}, named character vector where the name contains the source of the text.
 }
 \description{
 Wraps httr::GET with pre-specified headers and parses retrieved data.
diff --git a/man/elx_label_eurovoc.Rd b/man/elx_label_eurovoc.Rd
index bb33e84..48132f7 100644
--- a/man/elx_label_eurovoc.Rd
+++ b/man/elx_label_eurovoc.Rd
@@ -9,12 +9,12 @@ elx_label_eurovoc(uri_eurovoc = "", alt_labels = FALSE, language = "en")
 \arguments{
 \item{uri_eurovoc}{Character vector with valid EuroVoc URIs}
 
-\item{alt_labels}{If `TRUE`, results include comma-separated alternative labels in addition to the preferred label}
+\item{alt_labels}{If \code{TRUE}, results include comma-separated alternative labels in addition to the preferred label}
 
 \item{language}{Language in which to return the labels, in ISO 639 2-char code}
 }
 \value{
-A `tibble` containing EuroVoc unique concept identifiers and labels.
+A \code{tibble} containing EuroVoc unique concept identifiers and labels.
 }
 \description{
 Create a look-up table with labels for EuroVoc concept URIs. Only unique identifiers are returned.
diff --git a/man/elx_make_query.Rd b/man/elx_make_query.Rd
index 27b44b5..88ef682 100644
--- a/man/elx_make_query.Rd
+++ b/man/elx_make_query.Rd
@@ -48,55 +48,55 @@ elx_make_query(
 
 \item{sector}{Restrict the results to a given sector code}
 
-\item{include_corrigenda}{If `TRUE`, results include corrigenda}
+\item{include_corrigenda}{If \code{TRUE}, results include corrigenda}
 
-\item{include_celex}{If `TRUE`, results include CELEX identifier for each resource URI}
+\item{include_celex}{If \code{TRUE}, results include CELEX identifier for each resource URI}
 
-\item{include_lbs}{If `TRUE`, results include legal bases of legislation}
+\item{include_lbs}{If \code{TRUE}, results include legal bases of legislation}
 
-\item{include_date}{If `TRUE`, results include document date}
+\item{include_date}{If \code{TRUE}, results include document date}
 
-\item{include_date_force}{If `TRUE`, results include date of entry into force}
+\item{include_date_force}{If \code{TRUE}, results include date of entry into force}
 
-\item{include_date_endvalid}{If `TRUE`, results include date of end of validity}
+\item{include_date_endvalid}{If \code{TRUE}, results include date of end of validity}
 
-\item{include_date_transpos}{If `TRUE`, results include date of transposition deadline for directives}
+\item{include_date_transpos}{If \code{TRUE}, results include date of transposition deadline for directives}
 
-\item{include_date_lodged}{If `TRUE`, results include date a court case was lodged with the court}
+\item{include_date_lodged}{If \code{TRUE}, results include date a court case was lodged with the court}
 
-\item{include_force}{If `TRUE`, results include whether legislation is in force}
+\item{include_force}{If \code{TRUE}, results include whether legislation is in force}
 
-\item{include_eurovoc}{If `TRUE`, results include EuroVoc descriptors of subject matter}
+\item{include_eurovoc}{If \code{TRUE}, results include EuroVoc descriptors of subject matter}
 
-\item{include_citations}{If `TRUE`, results include citations (CELEX-labelled)}
+\item{include_citations}{If \code{TRUE}, results include citations (CELEX-labelled)}
 
-\item{include_citations_detailed}{If `TRUE`, results include citations (CELEX-labelled) with additional details}
+\item{include_citations_detailed}{If \code{TRUE}, results include citations (CELEX-labelled) with additional details}
 
-\item{include_author}{If `TRUE`, results include document author(s)}
+\item{include_author}{If \code{TRUE}, results include document author(s)}
 
-\item{include_directory}{If `TRUE`, results include the label of the Eur-Lex directory code}
+\item{include_directory}{If \code{TRUE}, results include the label of the Eur-Lex directory code}
 
-\item{include_directory_code}{If `TRUE`, results include the Eur-Lex directory code}
+\item{include_directory_code}{If \code{TRUE}, results include the Eur-Lex directory code}
 
-\item{include_sector}{If `TRUE`, results include the Eur-Lex sector code}
+\item{include_sector}{If \code{TRUE}, results include the Eur-Lex sector code}
 
-\item{include_ecli}{If `TRUE`, results include the ECLI identifier for court documents}
+\item{include_ecli}{If \code{TRUE}, results include the ECLI identifier for court documents}
 
-\item{include_court_procedure}{If `TRUE`, results include type of court procedure and outcome}
+\item{include_court_procedure}{If \code{TRUE}, results include type of court procedure and outcome}
 
-\item{include_judge_rapporteur}{If `TRUE`, results include the Judge-Rapporteur}
+\item{include_judge_rapporteur}{If \code{TRUE}, results include the Judge-Rapporteur}
 
-\item{include_advocate_general}{If `TRUE`, results include the Advocate General}
+\item{include_advocate_general}{If \code{TRUE}, results include the Advocate General}
 
-\item{include_court_formation}{If `TRUE`, results include the court formation}
+\item{include_court_formation}{If \code{TRUE}, results include the court formation}
 
-\item{include_court_scholarship}{If `TRUE`, results include court-curated relevant scholarship}
+\item{include_court_scholarship}{If \code{TRUE}, results include court-curated relevant scholarship}
 
-\item{include_court_origin}{If `TRUE`, results include country of origin of court case}
+\item{include_court_origin}{If \code{TRUE}, results include country of origin of court case}
 
-\item{include_original_language}{If `TRUE`, results include authentic language of document (usually case)}
+\item{include_original_language}{If \code{TRUE}, results include authentic language of document (usually case)}
 
-\item{include_proposal}{If `TRUE`, results include the CELEX of the proposal of the adopted legal act}
+\item{include_proposal}{If \code{TRUE}, results include the CELEX of the proposal of the adopted legal act}
 
 \item{order}{Order results by ids}
 
diff --git a/man/elx_run_query.Rd b/man/elx_run_query.Rd
index e8edddc..fa857d0 100644
--- a/man/elx_run_query.Rd
+++ b/man/elx_run_query.Rd
@@ -10,13 +10,13 @@ elx_run_query(
 )
 }
 \arguments{
-\item{query}{A valid SPARQL query specified by `elx_make_query()` or manually}
+\item{query}{A valid SPARQL query specified by \code{\link[=elx_make_query]{elx_make_query()}} or manually}
 
 \item{endpoint}{SPARQL endpoint}
 }
 \value{
 A data frame containing the results of the SPARQL query.
-Column `work` contains the Cellar URI of the resource.
+Column \code{work} contains the Cellar URI of the resource.
 }
 \description{
 Executes cURL request to a pre-defined endpoint of the EU Publications Office.