diff --git a/NAMESPACE b/NAMESPACE index a649c15..340e413 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -15,6 +15,7 @@ export(distribution.point_mass) export(distribution.poisson) export(distribution.uniform) export(estimate_mixture_of_two_normals) +export(is.distribution) export(logistic) export(logit) export(plot_posterior) diff --git a/R/distribution_R6_class.R b/R/distribution_R6_class.R index 40d5c47..6fc997f 100644 --- a/R/distribution_R6_class.R +++ b/R/distribution_R6_class.R @@ -237,14 +237,15 @@ distribution.abstract.class <- R6.class( ################################################################################/ # is.distribution ################################################################################/ -#' @title Distribution Classes +#' is.distribution #' -#' @description Available distributions implemented in `mastiff`. +#' Checks whether an object `x` is a R6 distribution class implemented by +#' [mastiff][Mastiff-Distributions], i.e. inherits either +#' [distribution.discrete.class] or [distribution.continuous.class] #' #' @param x An R object. #' -#' `is.distribution( x )` checks where an object `x` inherits from either -#' [distribution.discrete.class] or [distribution.continuous.class] -#' -#' `mastiff` +#' @seealso [Mastiff-Distributions] +#' @export + is.distribution <- function( x ) inherits( x, 'distribution.abstract.class' ) \ No newline at end of file diff --git a/man/is.distribution.Rd b/man/is.distribution.Rd index 5aed075..a1243b9 100644 --- a/man/is.distribution.Rd +++ b/man/is.distribution.Rd @@ -2,18 +2,18 @@ % Please edit documentation in R/distribution_R6_class.R \name{is.distribution} \alias{is.distribution} -\title{Distribution Classes} +\title{is.distribution} \usage{ is.distribution(x) } \arguments{ -\item{x}{An R object. - -\code{is.distribution( x )} checks where an object \code{x} inherits from either -\link{distribution.discrete.class} or \link{distribution.continuous.class} - -\code{mastiff}} +\item{x}{An R object.} } \description{ -Available distributions implemented in \code{mastiff}. +Checks whether an object \code{x} is a R6 distribution class implemented by +\link[=Mastiff-Distributions]{mastiff}, i.e. inherits either +\link{distribution.discrete.class} or \link{distribution.continuous.class} +} +\seealso{ +\link{Mastiff-Distributions} }