getCharInfo: getCharInfo

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

getCharInfo

Description

Retrieves the metadata from a Site object or a list of such objects.

Usage

getCharInfo(
  object,
  parkcode = NA,
  sitecode = NA,
  charname = NA,
  category = NA,
  info = NA
)

Arguments

object	Either a Characteristic object or a Site object, a Park object or a list of such objects.
parkcode	One or more parkcodes, in quotes. If object is a Park object or a list of Park objects, then the parkcode argument can be used to select which sites should be used.
sitecode	One or more sitecodes, in quotes. If object is a Park object or a list of Park or Site objects, then the sitcode argument can be used to select which sites should be used.
charname	Name of one or more characteristics, in quotes. Only those characteristics will be returned.
category	One or more categories of characteristics, in quotes. Only those categories of characteristics will be returned.
info	Type of information to return. One of several options, in quotes. "CharName" The name of the characteristic. "DisplayName" The display name of the characteristic. "Substrate" "The substrate of the characteristic. "SampleFraction SampleFraction The sample fraction of the characteristic. Stored as a length 1 character vector. "Category" The category for the charactersitic. Stored as a length 1 character vector. "CategoryDisplay The display name for the category of the characteristic. "Details" A description of the characteristic as needed. Stored as a length 1 character vector. "Units" The units of measurement of the characteristic. Stored as a length 1 character vector. "Data' A data.frame containing the water quality data. Should have columns representing the date, measurement, any QAQC flags etc. for each measurement. "LowerPoint","UpperPoint Indicates the assessment points. Values lower than the lower point are considered to have failed the assessement, whereas values higher than the higher point are considered failures. "LowerType","UpperType" The type of assessment indicated by the lower and upper points. "LowerDescription","UpperDescription" A description of the lowerand upper assesements point. "AssessmentDetails" Additional description of the assessement point. "SiteCode" Returns the site code. "SiteName" Returns the name of the site. "coords" Returns the latitude and longitude of the site as a length 2 vector. "type" Returns the type of the site. "ParkCode" Returns the park code for the park the site is in. "ParkShortName" The default. Returns the short name of the park the site is in. "ParkLongName" Returns the long name of the park the site is in. "Network Returns the network code for the network the site is in.

Value

Either a vector or a list with information for each character. Only the data option returns a list.

NCRN/NCRNWater documentation built on May 15, 2023, 9:50 p.m.