R/attributes.R

In BEE-Univ-Grenoble/BeePODYNA:

#' Returns the label of a BeePODYNA object
#'
#' \code{label} returns the label of \code{\link[BeePODYNA]{population}},
#' \code{\link[BeePODYNA]{community}} or \code{\link[BeePODYNA]{beepodyna}} object.
#'
#'
#' @param object is a BeePODYNA object.
#'
#' @return It returns a character with the label of the object.
#'
#' @examples
#'     pop<-population("Pop_1",42,2,200)
#'     label(pop)
#'
#' @author Nicolas BARTALUCCI <bartalucci.nico@gmail.com>
#'
#' @export
label <- function(object) {
  UseMethod("label")
}

#' @rdname label
#' @export
label.population <- function(object) {
  object$label
}

#' @rdname label
#' @export
label.community <- label.population


#' @rdname label
#' @export
label.beepodyna <- label.population



#' size_population
#'
#' \code{size_population} returns the size of the population given in parameter.
#'
#' @param pop is an object of the class 'population'.
#'
#' @return It returns the size of the population.
#'
#' @examples
#'     pop<-population("Pop_1",42,2,200)
#'     size_population(pop)
#'
#' @author Nicolas BARTALUCCI <bartalucci.nico@gmail.com>
#'
#' @export
size_population <- function(pop) {
  if (is_population(pop)) {pop$size}
  else {stop("The object must be a population.")}
}

#' capacity_population
#'
#' \code{capacity_population} returns the size of the population given in parameter.
#'
#' @param pop is an object of the class 'population'.
#'
#' @return It returns the capacity of the population.
#'
#' @examples
#'     pop<-population("Pop_1",42,2,200)
#'     capacity_population(pop)
#'
#' @author Nicolas BARTALUCCI <bartalucci.nico@gmail.com>
#'
#' @export
capacity_population <- function(pop) {
  if (is_population(pop)) {pop$capacity}
  else {stop("The object must be a population.")}
}

#' grate_population
#'
#' \code{grate_population} returns the growth rate of the population given in parameter.
#'
#' @param pop is an object of the class 'population'.
#'
#' @return It returns the growth rate of the population.
#'
#' @examples
#'     pop<-population("Pop_1",42,2,200)
#'     grate_population(pop)
#'
#' @author Nicolas BARTALUCCI <bartalucci.nico@gmail.com>
#'
#' @export
grate_population <- function(pop) {
  if (is_population(pop)) {pop$growth_rate}
  else {stop("The object must be a population.")}
}