diff --git a/R/rsimsum-package.R b/R/rsimsum-package.R index a8c2bca..26a41cb 100644 --- a/R/rsimsum-package.R +++ b/R/rsimsum-package.R @@ -1,14 +1,9 @@ -#' @title Analysis of Simulation Studies Including Monte Carlo Error -#' -#' @description Summarise results from simulation studies and compute Monte Carlo -#' standard errors of commonly used summary statistics. -#' This package is modelled on the 'simsum' user-written command in 'Stata' -#' (See White I.R., 2010 ). -#' -#' @name rsimsum -#' @docType package -#' @author Alessandro Gasparini (alessandro.gasparini@@ki.se) #' @import checkmate generics ggridges ggplot2 knitr lifecycle rlang scales stats +#' @keywords internal +"_PACKAGE" + +## usethis namespace: start +## usethis namespace: end NULL # Quiets concerns of R CMD check re: variable names used internally diff --git a/man/rsimsum-package.Rd b/man/rsimsum-package.Rd new file mode 100644 index 0000000..a579e6d --- /dev/null +++ b/man/rsimsum-package.Rd @@ -0,0 +1,28 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/rsimsum-package.R +\docType{package} +\name{rsimsum-package} +\alias{rsimsum} +\alias{rsimsum-package} +\title{rsimsum: Analysis of Simulation Studies Including Monte Carlo Error} +\description{ +Summarise results from simulation studies and compute Monte Carlo standard errors of commonly used summary statistics. This package is modelled on the 'simsum' user-written command in 'Stata' (White I.R., 2010 \url{https://www.stata-journal.com/article.html?article=st0200}), further extending it with additional performance measures and functionality. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://ellessenne.github.io/rsimsum/} + \item Report bugs at \url{https://github.com/ellessenne/rsimsum/issues} +} + +} +\author{ +\strong{Maintainer}: Alessandro Gasparini \email{alessandro@ellessenne.xyz} (\href{https://orcid.org/0000-0002-8319-7624}{ORCID}) + +Authors: +\itemize{ + \item Ian R. White +} + +} +\keyword{internal} diff --git a/man/rsimsum.Rd b/man/rsimsum.Rd deleted file mode 100644 index 44ed16a..0000000 --- a/man/rsimsum.Rd +++ /dev/null @@ -1,15 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/rsimsum-package.R -\docType{package} -\name{rsimsum} -\alias{rsimsum} -\title{Analysis of Simulation Studies Including Monte Carlo Error} -\description{ -Summarise results from simulation studies and compute Monte Carlo -standard errors of commonly used summary statistics. -This package is modelled on the 'simsum' user-written command in 'Stata' -(See White I.R., 2010 \url{https://www.stata-journal.com/article.html?article=st0200}). -} -\author{ -Alessandro Gasparini (alessandro.gasparini@ki.se) -}