Skip to contents

Reads a data release's manifest: the datasets load_taxonomic_resources() can load from it, and where each came from. Cite the sources of the datasets you use.

Usage

data_release_datasets(
  version = NULL,
  path = NULL,
  refresh_cache = FALSE,
  cache_dir = tools::R_user_dir("taxonAlign", "cache"),
  quiet = FALSE
)

Arguments

version

Data release to load, a date ("YYYY-MM-DD"); see data_release_versions(). Defaults to the latest release, or, with no internet connection, the newest release already downloaded.

path

Optional directory holding your own copy of a release's files (manifest.csv and the <dataset>.parquet files). version is then ignored.

refresh_cache

Logical; if TRUE, re-downloads the files even if they're cached. Defaults to FALSE.

cache_dir

Directory downloaded release files are cached in. Defaults to tools::R_user_dir("taxonAlign", "cache").

quiet

Logical; suppress progress messages. Defaults to FALSE.

Value

A tibble with one row per dataset: dataset, asset (the release file), rows, source, retrieved, licence and citation. The release is recorded in its "data_release" attribute.

Examples

# \donttest{
# needs the internet
if (curl::has_internet()) {
  data_release_datasets(version = "2026-11-14", cache_dir = tempfile())
}
#> Downloading manifest.csv (data release 2026-11-14)...
#> # A tibble: 6 × 7
#>   dataset            asset                rows source retrieved licence citation
#>   <chr>              <chr>               <int> <chr>  <chr>     <chr>   <chr>   
#> 1 NSL_algae          NSL_algae.parquet   21497 "http… 2026-11-… CC BY … Nationa…
#> 2 NSL_bryophytes     NSL_bryophytes.pa…   9170 "http… 2026-11-… CC BY … Nationa…
#> 3 NSL_fungi          NSL_fungi.parquet   27927 "http… 2026-11-… CC BY … Nationa…
#> 4 NSL_lichens        NSL_lichens.parqu…   8817 "http… 2026-11-… CC BY … Nationa…
#> 5 NSL_animals        NSL_animals.parqu… 319337 "Aust… 2026-09-… CC BY … Austral…
#> 6 CatalogueOfLife_AU CatalogueOfLife_A… 630158 "Cata… 2026-11-… CC BY … Bánki, …
# }