pb_ratio: Create a pb_ratio object to use in a trophic projection

In jdyen/trophic: Trophic Models of Energetics to Estimate Carrying Capacity

Description

A 'pb ratio' object stores the potentially stochastic ratio of production to standing biomass

Usage

build_pb_ratio(range, length = NULL, probs = NULL, type = "stochastic",
  ...)

is.pb_ratio(x)

## S3 method for class 'pb_ratio'
print(x, ...)

## S3 method for class 'pb_ratio'
plot(x, ...)

Arguments

range	a range of possible pb values
length	length of pb value sequence
probs	relative probabilities of pb values in pb_range
type	one of 'fixed', 'gradient', or 'stochastic' that determines how pb_values are treated
...	further arguments passed to or from other methods
x	an object to print or test as a pb_ratio object

Value

An object of class pb_ratio

Examples

library(trophic)

# Construct the pb_ratio object

test_pb <- build_pb_ratio(range = c(0.25, 5.75), probs = c(5, 20, 10, 3, 1, 1, 1))

# Test if object is of the type 'pb_ratio'
  
## Not run: 
is.pb_ratio(x)

## End(Not run)

# Print information about the 'pb_ratio' object

## Not run: 
print(x)

## End(Not run)

# Plot a 'pb_ratio' object

## Not run: 
plot(x)

## End(Not run)

jdyen/trophic documentation built on May 15, 2019, 3:19 p.m.