File: summary.sim.Rd

package info (click to toggle)
r-cran-lava 1.8.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,816 kB
  • sloc: sh: 13; makefile: 2
file content (49 lines) | stat: -rw-r--r-- 1,139 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/sim.default.R
\name{summary.sim}
\alias{summary.sim}
\title{Summary method for 'sim' objects}
\usage{
\method{summary}{sim}(
  object,
  estimate = NULL,
  se = NULL,
  confint = !is.null(se) && !is.null(true),
  true = NULL,
  fun,
  names = NULL,
  unique.names = TRUE,
  minimal = FALSE,
  level = 0.95,
  quantiles = c(0, 0.025, 0.5, 0.975, 1),
  ...
)
}
\arguments{
\item{object}{sim object}

\item{estimate}{(optional) columns with estimates}

\item{se}{(optional) columns with standard error estimates}

\item{confint}{(optional) list of pairs of columns with confidence limits}

\item{true}{(optional) vector of true parameter values}

\item{fun}{(optional) summary function}

\item{names}{(optional) names of estimates}

\item{unique.names}{if TRUE, unique.names will be applied to column names}

\item{minimal}{if TRUE, minimal summary will be returned}

\item{level}{confidence level (0.95)}

\item{quantiles}{quantiles (0,0.025,0.5,0.975,1)}

\item{...}{additional levels to lower-level functions}
}
\description{
Summary method for 'sim' objects
}