download_forcis_db {forcis} | R Documentation |
Download the FORCIS database
Description
Downloads the entire FORCIS database as a collection of five csv
files from
Zenodo (https://zenodo.org/doi/10.5281/zenodo.7390791). Additional
files will be also downloaded.
Usage
download_forcis_db(
path,
version = options()$forcis_version,
check_for_update = options()$forcis_check_for_update,
overwrite = FALSE,
timeout = 60
)
Arguments
path |
a |
version |
a |
check_for_update |
a |
overwrite |
a |
timeout |
an |
Details
The FORCIS database is regularly updated. The global structure of the tables
doesn’t change between versions but some bugs can be fixed and new records
can be added. This is why it is recommended to use the latest version of the
database. The package is designed to handle the versioning of the database on
Zenodo and will inform the user if a new version is available each time
he/she uses one of the read_*_data()
functions.
For more information, please read the vignette available at https://docs.ropensci.org/forcis/articles/database-versions.html.
Value
No return value. The FORCIS files will be saved in the path
folder.
References
Chaabane S, De Garidel-Thoron T, Giraud X, et al. (2023) The FORCIS database: A global census of planktonic Foraminifera from ocean waters. Scientific Data, 10, 354. DOI: doi:10.1038/s41597-023-02264-2.
See Also
read_plankton_nets_data()
to import the FORCIS database.
Examples
# Folder in which the database will be saved ----
# N.B. In this example we use a temporary folder but you should select an
# existing folder (for instance "data/").
path <- tempdir()
# Download the database ----
download_forcis_db(path, timeout = 300)
# Check the content of the folder ----
list.files(path, recursive = TRUE)