Skip to contents

Download Documents

Source: R/AllGenerics.R, R/hal_download.R
hal_download.Rd

Download Documents

Usage

hal_download(query, ...)

# S3 method for class 'HALQuery'
hal_download(
  query,
  destination = tempdir(),
  limit = 30,
  start = 0,
  progress = getOption("odyssey.progress"),
  verbose = getOption("odyssey.verbose"),
  ...
)

Arguments

query

An object of class HALQuery (typically returned by hal_query()).

...

Currently not used.

destination

A character string giving the directory path where the downloaded files are to be saved.

limit

An integer giving the maximum number of results. According to HAL policy, it cannot exceed 10000.

start

An integer specifying an absolute offset in the complete sorted list of matches to be used as the beginning of the current page. Only used if cursor is FALSE.

progress

A logical scalar: should a progress bar for for the request be printed?

verbose

A logical scalar: should extra information be reported?

Value

Invisibly returns destination.

See also

Other search tools: hal_search()

Author

N. Frerebeau

Examples

if (FALSE) { # \dontrun{
## Download the 10 most recent archaeological publication
## (if any files)
hal_query("archéologie") |>
  hal_filter("ART" %IN% "docType_s") |>
  hal_sort("producedDate_tdate", decreasing = TRUE) |>
  hal_download(limit = 10)
} # }