Extract attribute space held for a solution

Source: R/generics.R, R/RapSolved.R

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

space.held(x, y, species, space)

# S3 method for RapSolved
space.held(x, y = 0, species = NULL, space = 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.

space

NULL for all spaces or integer indicating a specific space.

Value

matrix object.

Examples

# \dontrun{
# load data
data(sim_rs)

# space held (%) for each species in best solution
space.held(sim_rs, 0)
#>   uniform (Space 1) normal (Space 1) bimodal (Space 1)
#> 1         0.9309091        0.9013438           0.92254

# space held (%) for each species in second solution
space.held(sim_rs, 2)
#>   uniform (Space 1) normal (Space 1) bimodal (Space 1)
#> 1         0.9266667        0.9035489         0.9319442

# space held (%) for each species in each solution
space.held(sim_rs)
#>   uniform (Space 1) normal (Space 1) bimodal (Space 1)
#> 1         0.9309091        0.9013438           0.92254
# }