get_rivers: Rivers included in habitat data by species

In danStich/anadrofish: Anadromous Fish Population Responses to Habitat Changes

Rivers included in habitat data by species

Description

Get names of rivers included in package for each species.

Usage

get_rivers(species = c("ALE", "AMS", "BBH"))

Arguments

species

Species for which rivers are returned Choices include American shad ("AMS"), alewife ("ALE"), and blueback herring ("BBH").

Details

The primary uses of this function are (1) so the user can see rivers that can be used for simulation, and (2) so the output can be passed to a random sampler for use in stochastic simulation via parallel processing.

Value

A character vector of rivers that are included in built-in habitat datasets for selected species.

Examples

# Example usage
## Not run: 
  
# Use get_rivers() to return names of rivers included in package
get_rivers(anadrofish::habitat)

# Sample a random river from those available
get_rivers(anadrofish::habitat)[sample(length(get_rivers(anadrofish::habitat)), 1)]  
  

## End(Not run)

danStich/anadrofish documentation built on Jan. 17, 2025, 9:46 a.m.