File: summary.aggre.Rd

package info (click to toggle)
r-cran-popepi 0.4.13%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,656 kB
  • sloc: sh: 13; makefile: 2
file content (38 lines) | stat: -rw-r--r-- 1,051 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/S3_definitions.R
\name{summary.aggre}
\alias{summary.aggre}
\title{Summarize an \code{aggre} Object}
\usage{
\method{summary}{aggre}(object, by = NULL, subset = NULL, ...)
}
\arguments{
\item{object}{an \code{aggre} object}

\item{by}{list of columns to summarize by - e.g. \code{list(V1, V2)}
where \code{V1} and \code{V2} are columns in the data.}

\item{subset}{a logical condition to subset results table by
before summarizing; use this to limit to a certain stratum. E.g.
\code{subset = sex == "male"}}

\item{...}{unused}
}
\value{
Returns a \code{data.table} --- a further aggregated version of \code{object}.
}
\description{
\code{summary} method function for \code{aggre} objects; see
\verb{[as.aggre]} and \verb{[aggre]}.
}
\seealso{
Other aggregation functions: 
\code{\link{aggre}()},
\code{\link{as.aggre}()},
\code{\link{lexpand}()},
\code{\link{setaggre}()}
}
\author{
Joonas Miettinen
}
\concept{aggregation functions}