R/GVS_metadata.R

In GVS: 'Geocoordinate Validation Service'

#'Get GVS metadata
#'
#'Returns metadata on GVS including version and citation information
#' @param bibtex_file Optional output file for writing bibtex citations.
#' @param ... Additional arguments passed to internal functions.
#' @return List containing: (1) bibtex-formatted citation information, (2) information about GVS data sources, and (3) GVS version information.
#' @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 GVS, as the GVS couldn't exist without these sources!
#' @note This function is a wrapper that returns the output of the functions GVS_citations, GVS_sources, and GVS_version.
#' @export
#' @examples {
#' metadata <- GVS_metadata()
#' }
#'
GVS_metadata <- function(bibtex_file=NULL, ...){

  output <- list()

  output[[1]] <- GVS_citations(...)
  output[[2]] <- GVS_sources(...)
  output[[3]] <- GVS_version(...)

  names(output)<-c("citations","version","sources")

  #Write the bibtex information if a file is specified
  if(!is.null(bibtex_file)){writeLines(text = output$citations$citation, con = bibtex_file)}

  return(output)

}