GNRS_metadata: Get GNRS metadata

Description Usage Arguments Value Note Examples

View source: R/gnrs_metadata.R

Description

Returns metadata on GNRS including version and citation information

Usage

1
GNRS_metadata(bibtex_file = NULL, ...)

Arguments

bibtex_file

Optional output file for writing bibtex citations.

...

Additional parameters passed to internal functions

Value

List containing: (1) bibtex-formatted citation information, (2) information about GNRS data sources, (3) GNRS version information, and (4) information that can be used in an acknowledgments statement..

Note

This function provides citation information in bibtex format that can be used with reference manager software (e.g. Paperpile, Zotero). Please remember to cite both the sources and the GNRS, as the GNRS couldn't exist without these sources!

This function is a wrapper that returns the output of the functions GNRS_citations, GNRS_sources, GNRS_version, and GNRS_acknowledgments.

Examples

1
2
3
4
## Not run: 
metadata <- GNRS_metadata()

## End(Not run)

GNRS documentation built on Oct. 14, 2021, 1:09 a.m.