Skip to contents

Make custom habitat for an existing river or a template for a new river of interest

custom_habitat_template.Rd

Function used to make habitat for rivers listed in get_rivers from the built-in dataset(s)

Usage

custom_habitat_template(
  species = c("AMS", "ALE", "BBH"),
  built_in = TRUE,
  river
)

Arguments

species

Species for which population dynamics will be simulated. Choices include American shad ("AMS"), alewife ("ALE"), and blueback herring ("BBH").

built_in

A logical indicating whether the custom habitat template is a a subset of built-in habitat datasets for the species indicated.

river

Character string specifying river name or NULL for custom river. If making custom habitat from an existing river in habitat (American shad), habitat_ale (Alewife), or habitat_bbh (Blueback herring), then river must be included in rivers from get_rivers for the target species. Otherwise, an arbitrary character string identifying river name is acceptable.