getSiteInfo: getSiteInfo

getSiteInfoR Documentation

getSiteInfo

Description

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

Usage

getSiteInfo(object, parkcode = NA, sitecode = NA, info)

Arguments

object

Either a Park object or a site object or a list of such objects.

parkcode

Park code of one or more parks, in quotes.

sitecode

Site code of one or more sites, in quotes.

info

Type of information to return. One of several options, in quotes.

"SiteCode"

The default. Returns the site code.

"SiteName"

Returns the name of the site.

"lat"

Returns the latitude of the site.

"long

Rerturns the longitude of the site.

"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.

Details

If object is a list or a Park object, then the list is filtered using both the parkcode and sitecode arguments. If object is a Site then both parkcode and sitecode are ignored.

Value

A vector of information for each site.


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