Access Documents From the Open Archive HAL • odyssey

Access data and download documents from the Open Archive HAL. This package provides a programmatic access to the HAL API.

Installation

You can install the development version from Codeberg with:

# install.packages("remotes")
remotes::install_git("https://codeberg.org/nfrerebeau/odyssey")

Usage

The use of odyssey involves three steps. First, a default query is created using hal_query(). Then, a set of functions allows to customize this query (see below). Finally, hal_search() and hal_download() allow to collect data and to download documents.

The following functions allow you to customize a query. They must be applied to the object returned by hal_query() and can be called in any order. hal_filter() can be used several times to add multiple search filters. See the HAL search API documentation for a list of available fields.

hal_query() allows to choose the fields to query and to define the query terms using boolean logic (q parameter).
hal_select() is used to select the fields to be returned in the results (fl parameter).
hal_filter() is used to retain all results that satisfy a conditions (fq parameter).
hal_sort() orders the results by the value of the select field (sort parameter). According to the HAL API documentation, you should avoid text fields and multi-valued fields which will produce unpredictable results.
hal_group() is used to group search results (group.* parameters).
hal_facet() is used to facet search results (facet.* parameters).

For a simple search, grouping terms in a list allows to combine them with AND, while grouping terms in a vector allows to combine all the terms with OR. If needed, the infix functions %AND%, %OR%, %NOT%, %IN%, %TO% allow to build more complex queries (remember that infix operators are composed left to right).

## Load packages
library(odyssey)

Get the 10 most recent articles about archaeology of Celts in France:

## Topic selection
## Will be combined with AND
topic <- list("archéologie", "Celtes", "France")

## Search publications with DOI
hal_query(topic) |>
  hal_select("doiId_s", "producedDate_tdate") |>
  hal_filter("" %TO% "" %IN% "doiId_s") |>
  hal_sort("producedDate_tdate", decreasing = TRUE) |>
  hal_search(limit = 10)
#>                        doiId_s   producedDate_tdate
#> 1     10.4000/books.pcjb.8230. 2021-08-01T00:00:00Z
#> 2      10.4000/books.pcjb.8397 2021-01-01T00:00:00Z
#> 3        10.4000/anabases.9669 2019-10-21T00:00:00Z
#> 4          10.26406/STETR81-08 2019-01-01T00:00:00Z
#> 5   10.4000/books.artehis.3178 2017-10-01T00:00:00Z
#> 6   10.4000/books.artehis.3265 2017-10-01T00:00:00Z
#> 7  10.4000/archeosciences.4457 2015-01-01T00:00:00Z
#> 8      10.3406/galia.2007.3311 2007-01-01T00:00:00Z
#> 9      10.3406/galia.2004.3184 2004-01-01T00:00:00Z
#> 10     10.3406/galia.2003.3143 2003-01-01T00:00:00Z

Get the number of documents in archaeology by journal:

hal_query("shs.archeo", field = "domainAllCode_s") |>
  hal_facet(field = "journalTitle_s", limit = 10) |>
  hal_search()
#> $journalTitle_s
#>                                                                    .value
#> 1        Bulletin de l'Association française pour l'étude de l'âge du fer
#> 2  Gallia - Fouilles et monuments archéologiques en France métropolitaine
#> 3                          Bulletin de la Société préhistorique française
#> 4                                   Cahier des thèmes transversaux ArScAn
#> 5                                                   Archéologie médiévale
#> 6                                                Quaternary International
#> 7                                          Les Nouvelles de l'archéologie
#> 8                                                             Archéologia
#> 9                                                  Dossiers d'Archéologie
#> 10                              Gallia - Archéologie de la France antique
#>    .counts
#> 1      693
#> 2      670
#> 3      627
#> 4      535
#> 5      492
#> 6      431
#> 7      406
#> 8      391
#> 9      391
#> 10     391
#> 
#> attr(,"numFound")
#> [1] 117621

Code of Conduct

Please note that the odyssey project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.