Title: | 'Geocoordinate Validation Service' |
---|---|
Description: | The 'Geocoordinate Validation Service' (GVS) runs checks of coordinates in latitude/longitude format. It returns annotated coordinates with additional flags and metadata that can be used in data cleaning. Additionally, the package has functions related to attribution and metadata information. More information can be found at <https://github.com/ojalaquellueva/gvs/tree/master/api>. |
Authors: | Brian Maitner [aut, cre] , Brad Boyle [aut], Rethvick Sriram Yugendra Babu [aut] |
Maintainer: | Brian Maitner <[email protected]> |
License: | MIT + file LICENSE |
Version: | 0.0.1 |
Built: | 2024-12-06 01:35:04 UTC |
Source: | CRAN |
GVS returns information on coordinate validity.
GVS(occurrence_dataframe, ...)
GVS(occurrence_dataframe, ...)
occurrence_dataframe |
A properly formatted dataframe, see |
... |
Additional arguments passed to internal functions. |
Dataframe containing GVS results.
results <- GVS(occurrence_dataframe = gvs_testfile)
results <- GVS(occurrence_dataframe = gvs_testfile)
Returns information needed to cite the GVS
GVS_citations(...)
GVS_citations(...)
... |
Additional arguments passed to internal functions. |
Dataframe containing bibtex-formatted citation information
This function provides citation information in bibtex format that can be used with reference manager software (e.g. Paperpile, Zotero). Please do remember to cite both the sources and the GVS, as the GVS couldn't exist without these sources!
{ citation_info <- GVS_citations() }
{ citation_info <- GVS_citations() }
Returns information on GVS collaborators
GVS_collaborators(...)
GVS_collaborators(...)
... |
Additional arguments passed to internal functions. |
Dataframe containing bibtex-formatted citation information
{ collaborator_info <- GVS_collaborators() }
{ collaborator_info <- GVS_collaborators() }
Returns the GVS data dictionary
GVS_data_dictionary(...)
GVS_data_dictionary(...)
... |
Additional arguments passed to internal functions. |
Dataframe containing bibtex-formatted citation information
{ data_dictionary <- GVS_data_dictionary() }
{ data_dictionary <- GVS_data_dictionary() }
Returns metadata on GVS including version and citation information
GVS_metadata(bibtex_file = NULL, ...)
GVS_metadata(bibtex_file = NULL, ...)
bibtex_file |
Optional output file for writing bibtex citations. |
... |
Additional arguments passed to internal functions. |
List containing: (1) bibtex-formatted citation information, (2) information about GVS data sources, and (3) GVS version information.
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 GVS, as the GVS couldn't exist without these sources!
This function is a wrapper that returns the output of the functions GVS_citations, GVS_sources, and GVS_version.
{ metadata <- GVS_metadata() }
{ metadata <- GVS_metadata() }
Return metadata about the current GVS sources
GVS_sources(...)
GVS_sources(...)
... |
Additional arguments passed to internal functions. |
Dataframe containing information about the sources used in the current GVS version.
{ sources <- GVS_sources() }
{ sources <- GVS_sources() }
A sample dataset showing the proper formatting of GVS inputs.
gvs_testfile
gvs_testfile
A data.frame with 27 observations of 2 variables:
Latitude, in decimal degrees
Longitude, in decimal degrees
...
Return metadata about the current GVS version
GVS_version(...)
GVS_version(...)
... |
Additional arguments passed to internal functions. |
Dataframe containing current GVS version number, build date, and code version.
{ NSR_version_metadata <- GVS_version() }
{ NSR_version_metadata <- GVS_version() }