R/format_for_opendata.R

In Centre-for-Marine-Applied-Research/strings: Compile, Format, and Visualize Sensor String Data

#'@title Format sensor string data for the Open Data portal
#'@param dat.tidy Data from a single deployment in tidy format, as returned by
#'  \code{convert_to_tidydata()}. Must include six columns:
#'  \code{DEPLOYMENT_PERIOD} (character), \code{TIMESTAMP} (POSIXct),
#'  \code{SENSOR} (character), \code{DEPTH} (character or ordered factor),
#'  \code{VARIABLE} (character), \code{VALUE} (numeric).
#'
#'@param location.info Dataframe of information about the deployment location.
#'  One observation of 5 columns: \code{county}, \code{waterbody},
#'  \code{station}, \code{lease}, \code{latitude}, and \code{longitude}.

#'@return Returns a dataframe of tidy data in the format for submission to the
#'  Open Data Portal. 10 columns: \code{WATERBODY}, \code{STATION},
#'  \code{LEASE}, \code{LATITUDE}, \code{LONGITUDE}, \code{DEPLOYMENT_PERIOD},
#'  \code{TIMESTAMP}, \code{SENSOR}, \code{DEPTH}, \code{VARIABLE}, \code{VALUE}

#'@family format
#'@author Danielle Dempsey
#'
#'@importFrom tidyr separate
#'@import dplyr
#'@export

format_for_opendata <- function(dat.tidy, location.info) {

  dat.tidy %>%
    mutate(COUNTY = location.info$county,
           WATERBODY = location.info$waterbody,
           STATION = location.info$station,
           LEASE = as.character(location.info$lease),
           LATITUDE = location.info$latitude,
           LONGITUDE = location.info$longitude,
           TIMESTAMP = format(TIMESTAMP, "%Y-%m%-%d %H:%M:%S")) %>%
    mutate(LEASE = if_else(LEASE == "n/a" | LEASE == "N/A" , "NA", LEASE)) %>%
    select(WATERBODY, STATION, LEASE,
           LATITUDE, LONGITUDE, DEPLOYMENT_PERIOD,
           TIMESTAMP, SENSOR, DEPTH, VARIABLE, VALUE)

}