assign_trout_class: Assign the appropriate

In BWAM/stayCALM: Stay Calm when Applying a Consolidated Assessment Listing Methodology (CALM)

Description

Assign the appropriate

Usage

assign_trout_class(.trout_class, .class)

Arguments

.trout_class

a vector of strings signifying the types of trout based variants should be assigned to a waterbody class. "all" The original class will be returned as well as "(t)" and "(ts)" variants. For example, if "a" is the class supplied, "a, a(t), a(ts)" will be returned.\ "trout" Only a trout variant, "(t)", of the supplied class will be returned. For example, if "a" is the class supplied, "a(t)" will be returned.\ "trout_spawning" Only a trout spawning variant, "(ts)", of the supplied class will be returned. For example, if "a" is the class supplied, "a(ts)" will be returned.\ "non_trout" The original class will be returned unaltered. For example, if "a" is the class supplied, "a" will be returned. In practice "non_trout" does not differ from "none." These two strings are supplied to act exffectively as explicit NAs and to provide the user a little bit of content related to how the class is treated in water quality standard regulations.\ "none"The original class will be returned unaltered. For example, if "a" is the class supplied, "a" will be returned. In practice "none" does not differ from "non_trout." These two strings are supplied to act exffectively as explicit NAs and to provide the user a little bit of content related to how the class is treated in water quality standard regulations.

Value

A list of character strings specifying the relavent class and trout variants.

Examples

# "a", "a(t)", "a(ts)"
assign_trout_class(.trout_class = "all", .class = "a")
# "a(t)"
assign_trout_class(.trout_class = "trout", .class = "a")
# "a(ts)"
assign_trout_class(.trout_class = "trout_spawning", .class = "a")
# "a"
assign_trout_class(.trout_class = "non_trout", .class = "a")
# "a"
assign_trout_class(.trout_class = "none", .class = "a")

BWAM/stayCALM documentation built on May 21, 2020, 3:24 p.m.