cite_ecotox: Cite the downloaded copy of the ECOTOX database

View source: R/database_access.r

cite_ecotoxR Documentation

Cite the downloaded copy of the ECOTOX database

Description

[Stable] Cite the downloaded copy of the ECOTOX database and this package (citation("ECOTOXr")) for reproducible results.

Usage

cite_ecotox(path = get_ecotox_path(), version)

Arguments

path

A character string with the path to the location of the local database \(default is get_ecotox_path()\).

version

A character string referring to the release version of the database you wish to locate. It should have the same format as the date in the EPA download link, which is month, day, year, separated by underscores ("%m_%d_%Y"). When missing, the most recent available copy is selected automatically.

Details

When you download a copy of the EPA ECOTOX database using download_ecotox_data(), a BibTex file is stored that registers the database release version and the access (= download) date. Use this function to obtain a citation to that specific download.

In order for others to reproduce your results, it is key to cite the data source as accurately as possible.

Value

Returns a vector of bibentry()'s, containing a reference to the downloaded database and this package.

Author(s)

Pepijn de Vries

Examples

## Not run: 
## In order to cite downloaded database and this package:
cite_ecotox()

## End(Not run)

ECOTOXr documentation built on Sept. 20, 2024, 5:06 p.m.