plot_steepness: Plots probability distribution function of stock-recruit...

Description Usage Arguments Value Note Author(s) See Also Examples

View source: R/report_auxiliary.R

Description

Plots the probability distribution function of steepness from the mean and standard deviation.

Usage

1
2
3
4
5
6
7
plot_steepness(
  m,
  sd,
  is_transform = FALSE,
  SR = c("BH", "Ricker"),
  color = "black"
)

Arguments

m

The mean of the distribution (vectorized).

sd

The standard deviation of the distribution (vectorized).

is_transform

Logical, whether the mean and standard deviation are in normal space (FALSE) or transformed space.

SR

The stock recruitment relationship (determines the range and, if relevant, transformation of steepness).

color

A vector of colors.

Value

A plot of the probability distribution function. Vertical dotted line indicates mean of distribution.

Note

The function samples from a beta distribution with parameters alpha and beta that are converted from the mean and standard deviation. Then, the distribution is transformed from 0 - 1 to 0.2 - 1.

Author(s)

Q. Huynh

See Also

plot_lognormalvar plot_betavar

Examples

1
2
3
mu <- DLMtool::Simulation_1@steep
stddev <- DLMtool::Simulation_1@steep * DLMtool::Simulation_1@CV_steep
plot_steepness(mu, stddev)

tcarruth/MSEtool documentation built on Oct. 19, 2020, 6:09 a.m.