addmargins {stats}  R Documentation 
Puts Arbitrary Margins on Multidimensional Tables or Arrays
Description
For a given table one can specify which of the classifying factors to expand by one or more levels to hold margins to be calculated. One may for example form sums and means over the first dimension and medians over the second. The resulting table will then have two extra levels for the first dimension and one extra level for the second. The default is to sum over all margins in the table. Other possibilities may give results that depend on the order in which the margins are computed. This is flagged in the printed output from the function.
Usage
addmargins(A, margin = seq_along(dim(A)), FUN = sum, quiet = FALSE)
Arguments
A 
table or array. The function uses the presence of the

margin 
vector of dimensions over which to form margins. Margins
are formed in the order in which dimensions are specified in

FUN 

quiet 
logical which suppresses the message telling the order in which the margins were computed. 
Details
If the functions used to form margins are not commutative, the result
depends on the order in which margins are computed. Annotation
of margins is done via naming the FUN
list.
Value
A table
or array
with the same number of
dimensions as A
, but
with extra levels of the dimensions mentioned in margin
. The
number of levels added to each dimension is the length of the entries
in FUN
. A message with the order of computation of margins is
printed.
Author(s)
Bendix Carstensen, Steno Diabetes Center & Department of Biostatistics, University of Copenhagen, https://BendixCarstensen.com, autumn 2003. Margin naming enhanced by Duncan Murdoch.
See Also
Examples
Aye < sample(c("Yes", "Si", "Oui"), 177, replace = TRUE)
Bee < sample(c("Hum", "Buzz"), 177, replace = TRUE)
Sea < sample(c("White", "Black", "Red", "Dead"), 177, replace = TRUE)
(A < table(Aye, Bee, Sea))
(aA < addmargins(A))
ftable(A)
ftable(aA)
# Noncommutative functions  note differences between resulting tables:
ftable( addmargins(A, c(3, 1),
FUN = list(list(Min = min, Max = max),
Sum = sum)))
ftable( addmargins(A, c(1, 3),
FUN = list(Sum = sum,
list(Min = min, Max = max))))
# Weird function needed to return the N when computing percentages
sqsm < function(x) sum(x)^2/100
B < table(Sea, Bee)
round(sweep(addmargins(B, 1, list(list(All = sum, N = sqsm))), 2,
apply(B, 2, sum)/100, `/`), 1)
round(sweep(addmargins(B, 2, list(list(All = sum, N = sqsm))), 1,
apply(B, 1, sum)/100, `/`), 1)
# A total over Bee requires formation of the Beemargin first:
mB < addmargins(B, 2, FUN = list(list(Total = sum)))
round(ftable(sweep(addmargins(mB, 1, list(list(All = sum, N = sqsm))), 2,
apply(mB, 2, sum)/100, `/`)), 1)
## Zero.Printing table+margins:
set.seed(1)
x < sample( 1:7, 20, replace = TRUE)
y < sample( 1:7, 20, replace = TRUE)
tx < addmargins( table(x, y) )
print(tx, zero.print = ".")