Extract amount held for a solution

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

amount.held(x, y, species)

# S3 method for 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

# \dontrun{
# load data
data(sim_rs)

# amount held (%) in best solution for each species
amount.held(sim_rs, 0)
#>   uniform    normal   bimodal
#> 1     0.2 0.2068042 0.2258136

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

# amount held (%) in second solution for each species
amount.held(sim_rs, 2)
#>   uniform    normal   bimodal
#> 1     0.2 0.2105088 0.2422478

# amount held (%) in each solution for each species
amount.held(sim_rs, NULL)
#>   uniform    normal   bimodal
#> 1     0.2 0.2068042 0.2258136
#> 2     0.2 0.2105088 0.2422478
#> 3     0.2 0.2090607 0.2503469
# }