R/S3_methods.R

In biogrowth: Modelling of Population Growth

## "is." methods

#' Test of FitDynamicGrowth object
#'
#' Tests if an object is of class `FitDynamicGrowth`.
#'
#' @param x object to be checked.
#'
#' @return A boolean specifying whether `x` is of class
#'         `FitDynamicGrowth`
#'
#' @export
#'
is.FitDynamicGrowth <- function(x) inherits(x, "FitDynamicGrowth")

#' Test of FitDynamicGrowthMCMC object
#'
#' Tests if an object is of class `FitDynamicGrowthMCMC`.
#'
#' @param x object to be checked.
#'
#' @return A boolean specifying whether `x` is of class
#'         `FitDynamicGrowthMCMC`
#'
#' @export
#'
is.FitDynamicGrowthMCMC <- function(x) inherits(x, "FitDynamicGrowthMCMC")

#' Test of FitIsoGrowth object
#'
#' Tests if an object is of class `FitIsoGrowth`.
#'
#' @param x object to be checked.
#'
#' @return A boolean specifying whether `x` is of class
#'         `FitIsoGrowth`
#'
#' @export
#'
is.FitIsoGrowth <- function(x) inherits(x, "FitIsoGrowth")

#' Test of FitSecondaryGrowth object
#'
#' Tests if an object is of class `FitSecondaryGrowth`.
#'
#' @param x object to be checked.
#'
#' @return A boolean specifying whether `x` is of class
#'         `FitSecondaryGrowth`
#'
#' @export
#'
is.FitSecondaryGrowth <- function(x) inherits(x, "FitSecondaryGrowth")

#' Test of DynamicGrowth object
#'
#' Tests if an object is of class `DynamicGrowth`.
#'
#' @param x object to be checked.
#'
#' @return A boolean specifying whether `x` is of class
#'         `DynamicGrowth`
#'
#' @export
#'
is.DynamicGrowth <- function(x) inherits(x, "DynamicGrowth")

#' Test of IsothermalGrowth object
#'
#' Tests if an object is of class `IsothermalGrowth`.
#'
#' @param x object to be checked.
#'
#' @return A boolean specifying whether `x` is of class
#'         `IsothermalGrowth`
#'
#' @export
#'
is.IsothermalGrowth <- function(x) inherits(x, "IsothermalGrowth")

#' Test of MCMCgrowth object
#'
#' Tests if an object is of class `MCMCgrowth`.
#'
#' @param x object to be checked.
#'
#' @return A boolean specifying whether `x` is of class
#'         `MCMCgrowth`
#'
#' @export
#'
is.MCMCgrowth <- function(x) inherits(x, "MCMCgrowth")

#' Test of StochasticGrowth object
#'
#' Tests if an object is of class `StochasticGrowth`.
#'
#' @param x object to be checked.
#'
#' @return A boolean specifying whether `x` is of class
#'         `StochasticGrowth`
#'
#' @export
#'
is.StochasticGrowth <- function(x) inherits(x, "StochasticGrowth")

#' Test of FitMultipleDynamicGrowth object
#'
#' Tests if an object is of class `FitMultipleDynamicGrowth`.
#'
#' @param x object to be checked.
#'
#' @return A boolean specifying whether `x` is of class
#'         `FitMultipleDynamicGrowth`
#'
#' @export
#'
is.FitMultipleDynamicGrowth <- function(x) inherits(x, "FitMultipleDynamicGrowth")

#' Test of FitMultipleDynamicGrowthMCMC object
#'
#' Tests if an object is of class `FitMultipleDynamicGrowthMCMC`.
#'
#' @param x object to be checked.
#'
#' @return A boolean specifying whether `x` is of class
#'         `FitMultipleDynamicGrowthMCMC`
#'
#' @export
#'
is.FitMultipleDynamicGrowthMCMC <- function(x) inherits(x, "FitMultipleGrowthMCMC")


#' Test of GlobalGrowthFit object
#'
#' Tests if an object is of class [GlobalGrowthFit]
#'
#' @param x object to be checked.
#'
#' @return A boolean specifying whether `x` is of class GlobalGrowthFit
#'
#' @export
#'
is.GlobalGrowthFit <- function(x) inherits(x, "GlobalGrowthFit")

#' Test of GrowthFit object
#'
#' Tests if an object is of class [GrowthFit]
#'
#' @param x object to be checked.
#'
#' @return A boolean specifying whether `x` is of class GrowthFit
#'
#' @export
#'
is.GrowthFit <- function(x) inherits(x, "GrowthFit")

#' Test of GrowthPrediction object
#'
#' Tests if an object is of class [GrowthPrediction]
#'
#' @param x object to be checked.
#'
#' @return A boolean specifying whether `x` is of class GrowthPrediction
#'
#' @export
#'
is.GrowthPrediction <- function(x) inherits(x, "GrowthPrediction")

#' Test of GrowthUncertainty object
#'
#' Tests if an object is of class [GrowthUncertainty]
#'
#' @param x object to be checked.
#'
#' @return A boolean specifying whether `x` is of class GrowthUncertainty
#'
#' @export
#'
is.GrowthUncertainty <- function(x) inherits(x, "GrowthUncertainty")