R/NCRNWater_Site_Class_def.R

In NCRN/NCRNWater: Data analysis and visualization for NPS I&M water monitoring

#' @include NCRNWater_Park_Class_def.R
#' @title S4 Class Definition for Site object in  NCRNWater
#' 
#' @description
#' An S4 class that contains the data from water monitoring from a single site. Data on individual characteristics will be stored as 
#' one o more S4 objects in each site object. Site objects are themselves stored as a list within a park object.
#' 
#' @slot SiteCode A short code to designate the site, stored as a length 1 character \code{vector}. 
#' @slot SiteName A name for the site. Stored as a length 1 character \code{vector}. 
#' @slot Lat A length 1 numeric \code{vector} containing the latitude of the site in WGS84 coordinates.
#' @slot Long A length 1 numeric \code{vector} containing the longitude of the site in WGS84 coordinates.
#' @slot Type The type of water body at the site - e.g. Stream, River, Lake, Ocean etc. Stored as a length 1 character \code{vector}.
#' @slot Characteristics A \code{list} of water quality characteristic objects that include the water quality data and associated meta-data.
#' 
#' @exportClass Site

setClass(Class="Site",
         slots=c(SiteCode="character",
                 SiteName="character",
                 Lat="numeric",
                 Long="numeric",
                 Type="character",
                 Characteristics="list"
          ),
         
         prototype = list(SiteCode=character(),
                          SiteName=character(),
                          Lat=numeric(),
                          Long=numeric(),
                          Type=character(),
                          Characteristics=list()
           
         )
)