R/simulate.R

In ouch: Ornstein-Uhlenbeck Models for Phylogenetic Comparative Hypotheses

#' Simulations of a phylogenetic trait model
#'
#' `simulate` generates random deviates from a fitted model.
#' 
#' @name simulate
#' @docType methods
#' @rdname simulate
#' @family methods for ouch trees
#' @importFrom stats simulate
#'
#' @return
#' `simulate` returns a list of data-frames, each comparable to the original data.
#' @param object fitted model object to simulate.
#' @param nsim integer; number of independent simulations.
#' @param seed integer; if non-`NULL`, the RNG will be initialized with this seed for the simulations.
#' The RNG will be reset to its pre-existing state when `simulate` returns.
#' @param ... additional arguments, ignored.
NULL