File: margins.Rd

package info (click to toggle)
r-cran-reshape2 1.4.4-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 292 kB
  • sloc: cpp: 246; sh: 9; makefile: 5
file content (27 lines) | stat: -rw-r--r-- 813 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/helper-margins.r
\name{margins}
\alias{margins}
\title{Figure out margining variables.}
\usage{
margins(vars, margins = NULL)
}
\arguments{
\item{vars}{a list of character vectors giving the variables in each
dimension}

\item{margins}{a character vector of variable names to compute margins for.
\code{TRUE} will compute all possible margins.}
}
\value{
list of margining combinations, or \code{NULL} if none. These are
  the combinations of variables that should have their values set to
  \code{(all)}
}
\description{
Given the variables that form the rows and columns, and a set of desired
margins, works out which ones are possible. Variables that can't be
margined over are dropped silently.
}
\keyword{internal}
\keyword{manip}