R/get_cefas_dataset_fields.R

In MarineEcosystemResearchProgramme/merpWS: Wrappers for existing marine web services

#' List fields for a given CEFAS API data source
#' 
#' The function returns the fields for the csv files that can be accessed
#' via the CEFAS API.
#'
#' \code{get_cefas_dataset_fields} takes one argument recordset_id. It returns
#' all fields for the corresponding csv file, if it does exist. The list of csv
#' files and their corresponding recordset ids can be found be running the
#' function get_cefas_datasets and extracting the to_download object.  
#' 
#' @param recordset_id is an ID number for the recordset the fields are to be
#' extracted for.
#' 
#' @return a fields data.frame containg the name of all fields, an Id reference for each field,
#' the type of information it contains, the exact column name and information about
#' minimum/maximum values
#' 
#' @examples
#' mydata <- get_cefas_datasets()
#' mydownloadable <- mydata$to_download
#' get_cefas_dataset_fields(mydownloadable$Id[1])
#' 
#' 
get_cefas_dataset_fields <- function(recordset_id){
  myurl <- paste("https://cefasapp.cefas.co.uk/api/recordsets/", recordset_id, "/fields", sep = "")
  dat <- suppressWarnings(jsonlite::fromJSON(readLines(myurl)))
  return(fields = dat)
}