space.held: Extract attribute space held for a solution

View source: R/generics.R

space.heldR Documentation

Extract attribute space held for a solution

Description

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

Usage

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

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

See Also

RapResults(), RapSolved().

Examples

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

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

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

# space held (%) for each species in each solution
space.held(sim_rs)

## End(Not run)

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