R/getPhylo_speciesRaster.R

Defines functions getPhylo_speciesRaster

Documented in getPhylo_speciesRaster

##' @title Get phylogeny from speciesRaster
##'
##' @description Return the phylo item from a speciesRaster object. 
##'
##' @param x object of class \code{speciesRaster}
##'
##' @return The phylogeny in the \code{phylo} location of the speciesRaster.
##'
##' @author Pascal Title
##' 
##' @examples
##' x <- addPhylo_speciesRaster(tamiasSpRas, tamiasTree)
##' getPhylo_speciesRaster(x)
##' 
##' @export

getPhylo_speciesRaster <- function(x) {
	
	if (!inherits(x, 'speciesRaster')) {
		stop('x must be of class speciesRaster.')
	}
		
	if (!inherits(x[['phylo']], 'phylo')) {
		stop('Phylogeny not present.')
	}
	
	return(x[['phylo']])	
}
ptitle/speciesRaster documentation built on June 11, 2022, 1:35 a.m.