Nothing
#' @importFrom stats vcov
#' @export
stats::vcov
#' Extract the variance co-variance matrix
#'
#' A generic method for extracting the variance covariance matrix from a design
#' object
#'
#' @param object A model object of class 'spdesign'
#' @param ... Additional arguments passed to the function
#'
#' @method vcov spdesign
#'
#' @return A matrix with row- and column names equal to the parameter names
#'
#' @export
vcov.spdesign <- function(object, ...) {
return(
object[["vcov"]]
)
}
#' Create a summary of the experimental design
#'
#' @inheritParams vcov.spdesign
#'
#' @method summary spdesign
#'
#' @return No return value. Prints a summary of the 'spdesign' object to the
#' console
#'
#' @export
summary.spdesign <- function(object, ...) {
print(object, ...)
cat("\n")
cat("Printing the first few rows of the design \n")
print(utils::head(object[["design"]]))
cat("\n")
cat("---------------------------------------------------------------------\n")
if ("blocks_correlation" %in% names(object)) {
cat("Correlation between the blocking vector and attributes: \n \n")
print(object$blocks_correlation)
cat("\n")
cat("---------------------------------------------------------------------\n")
}
}
#' Correlation
#'
#' Calculate the correlation of the design. The function gets the design from
#' the design object before passing it to \code{\link{cor}} from stats.
#' This is a wrapper around \code{\link{cor}}.
#'
#' Note that when your design includes constants, the function will print a
#' warning because the standard deviation of a constant is 0.
#'
#' @inheritParams print.spdesign
#'
#' @return A matrix with correlations
#'
#' @export
cor <- function(x, ...) {
return(
stats::cor(x[["design"]], y = NULL, use = "everything", method = c("pearson", "kendall", "spearman"))
)
}
#' A generic function for printing an 'spdesign' object
#'
#' @param x A model object of class 'spdesign'
#' @param ... Additional parameters passed to the function
#'
#' @method print spdesign
#'
#' @return No return value. Prints the 'spdesign' object.
#'
#' @export
print.spdesign <- function(x, ...) {
cat("---------------------------------------------------------------------\n")
cat("An 'spdesign' object\n\n")
cat("Utility functions:\n")
for (i in seq_along(x$utility)) {
cat(names(x$utility)[[i]], ":", clean_utility(x$utility)[[i]], "\n")
}
cat("\n\n")
print(x$efficiency_criteria)
cat("\n")
cat("---------------------------------------------------------------------\n")
}
#' Generic for extracting the vector of priors
#'
#' @inheritParams vcov.spdesign
#'
#' @return A vector of named priors used in the optimization
#'
#' @export
coef.spdesign <- function(object, ...) {
return(
object[["prior_values"]]
)
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.