neonstore (version 0.2.1)

neon_citation: Generate the appropriate citation for your data

Description

Generate the appropriate citation for your data

Usage

neon_citation(product = NULL, download_date = Sys.Date(), dir = neon_dir())

Arguments

product

A NEON productCode. See neon_download.

download_date

Date of download to be included in citation. default is today's date, see details.

dir

Location where files should be downloaded. By default will use the appropriate applications directory for your system (see rappdirs::user_data_dir). This default also be configured by setting the environmental variable NEONSTORE_HOME, see Sys.setenv or Renviron.

Value

returns a utils::bibentry object, which can be used as text or formatted for bibtex.

Details

Note that the neon_download() does not record download date for each file. Citing a single product download date is after all rather meaningless, as parts of a products may not have all been downloaded on different dates. Indeed, neon_download() is designed in precisely this way, to allow easy updating of downloads without re-downloading older data.

References

https://www.neonscience.org/data/about-data/data-policies

Examples

# NOT RUN {
neon_citation("DP1.10003.001")

## or the citation for all products in store:
neon_citation()

## as bibtex
format(neon_citation("DP1.10003.001"), "bibtex")

# }