R/method-mcmcdb_parameters.R

In jrnold/mcmcdb: MCMC sample database classes

#' @include package.R
#' @include class-McmcdbMem.R
#' @exportMethod mcmcdb_parameters
NULL

#' @name mcmcdb_parameters-methods
#' @rdname mcmcdb_parameters-methods
#' @aliases mcmcdb_parameters
#' @aliases mcmcdb_parameters-methods
#' @title Get parameters of Mcmcdb object
#'
#' @param object object
#' @return An object of class \code{\linkS4class{McmcdbParameters}}.
setGeneric("mcmcdb_parameters",
           function(object, ...) {
             standardGeneric("mcmcdb_parameters")
           })

#' @rdname mcmcdb_parameters-methods
#' @aliases mcmcdb_parameters,McmcdbMem-method
#' @family McmcdbMem methods
setMethod("mcmcdb_parameters", "McmcdbMem",
          function(object) object@parameters)