Learn R Programming

BioGeoBEARS (version 0.2.1)

areas_list_to_states_list_new: Convert a list of areas to a list of geographic ranges (states); R version

Description

R version of areas_list_to_states_list_old, which makes use of cladoRcpp's rcpp_areas_list_to_states_list.

Usage

areas_list_to_states_list_new(areas = c("A", "B", "C"), maxareas = length(areas), include_null_range = TRUE, split_ABC = TRUE)

Arguments

areas
a list of areas (character or number; the function converts these to numbers, starting with 0)
maxareas
maximum number of areas in this analyses
include_null_range
TRUE or FALSE, should the NULL range be included in the possible states? (e.g., LAGRANGE default is yes)
split_ABC
TRUE or FALSE If TRUE the output will consist of a list of lists (c("A","B","C"), c("A","B"), c("A","D"), etc.); if FALSE, the list of areas will be collapsed ("ABC", "AB", "AD", etc.).

Value

states_list A list of the states.

Details

This is the original R version of the function which converts a list of possible areas to a list of all possible states (geographic ranges). This gets slow for large numbers of areas.

The function is mostly replaced by rcpp_areas_list_to_states_list in optimized code, but is still used in some places for display purposes.

References

http://phylo.wikidot.com/matzke-2013-international-biogeography-society-poster https://code.google.com/p/lagrange/

Matzke_2012_IBS

ReeSmith2008

See Also

numstates_from_numareas, rcpp_areas_list_to_states_list

Examples

Run this code
areas = c("A","B","C")
areas_list_to_states_list_new(areas=areas, maxareas=length(areas),
include_null_range=TRUE, split_ABC=TRUE)
areas_list_to_states_list_new(areas=areas, maxareas=length(areas),
include_null_range=TRUE, split_ABC=FALSE)
areas_list_to_states_list_new(areas=areas, maxareas=length(areas),
include_null_range=FALSE, split_ABC=TRUE)
areas_list_to_states_list_new(areas=areas, maxareas=length(areas),
include_null_range=FALSE, split_ABC=FALSE)
areas_list_to_states_list_new(areas=areas, maxareas=2,
include_null_range=TRUE, split_ABC=TRUE)
areas_list_to_states_list_new(areas=areas, maxareas=2,
include_null_range=TRUE, split_ABC=FALSE)
areas_list_to_states_list_new(areas=areas, maxareas=2,
include_null_range=FALSE, split_ABC=TRUE)
areas_list_to_states_list_new(areas=areas, maxareas=2,
include_null_range=FALSE, split_ABC=FALSE)
areas_list_to_states_list_new(areas=areas, maxareas=1,
include_null_range=TRUE, split_ABC=TRUE)
areas_list_to_states_list_new(areas=areas, maxareas=1,
include_null_range=TRUE, split_ABC=FALSE)
areas_list_to_states_list_new(areas=areas, maxareas=1,
include_null_range=FALSE, split_ABC=TRUE)
areas_list_to_states_list_new(areas=areas, maxareas=1,
include_null_range=FALSE, split_ABC=FALSE)

Run the code above in your browser using DataLab