amount.held: Extract amount held for a solution

In jeffreyhanson/raptr: Representative and Adequate Prioritization Toolkit in R

Extract amount held for a solution

Description

This function returns the amount held for each species in a solution.

Usage

amount.held(x, y, species)

## S3 method for class 'RapSolved'
amount.held(x, y = 0, species = NULL)

Arguments

x	RapResults() or RapSolved() object.
y	Available inputs include: NULL to return all values, integer number specifying the solution for which the value should be returned, and 0 to return the value for the best solution.
species	NULL for all species or integer indicating species.

Value

base::matrix() or numeric vector depending on arguments.

See Also

RapResults(), RapSolved().

Examples

## Not run: 
# load data
data(sim_rs)

# amount held (%) in best solution for each species
amount.held(sim_rs, 0)

# amount held (%) in best solution for species 1
amount.held(sim_rs, 0, 1)

# amount held (%) in second solution for each species
amount.held(sim_rs, 2)

# amount held (%) in each solution for each species
amount.held(sim_rs, NULL)

## End(Not run)

jeffreyhanson/raptr documentation built on Feb. 3, 2024, 10:56 p.m.