getClarity: Get light attenuation coefficient for a given lake

Description Usage Arguments Details Value Author(s) Examples

View source: R/lake_attribute_functions.R

Description

Returns the light attenuation coefficient for a lake with the given ID

Usage

1
getClarity(site_id, default.if.null = FALSE)

Arguments

site_id

The character ID for the requested data

default.if.null

boolean indicating if default Kd should be used if lake has no observations

Details

TODO

Value

Light attenuation coefficient in m^-1

Author(s)

Luke Winslow, Jordan Read

Examples

1
2
3
4
5
#NA returned when no site with that ID found
getClarity(c('6100', '10000', 'asdf'))

#Default can be requested as well
getClarity(c('6100','asdf', '10000', 'asdf'), default.if.null=TRUE)

USGS-R/mda.lakes documentation built on Nov. 13, 2020, 8:28 p.m.