11% File src / library / stats / man / loglin.Rd
22% Part of the R package , https : // www.R - project.org
3- % Copyright 1995 - 2018 R Core Team
3+ % Copyright 1995 - 2024 R Core Team
44% Distributed under GPL 2 or later
55
66\name {loglin }
@@ -29,7 +29,8 @@ loglin(table, margin, start = rep(1, length(table)), fit = FALSE,
2929 1 (sometimes represented as \sQuote {[12 ][13 ]}).
3030
3131 The names of factors (i.e. , \code {names(dimnames(table ))}) may be
32- used rather than numeric indices.
32+ used rather than numeric indices. Or \code {NULL } or \code {list ()}
33+ to specify fitting no margins.
3334 }
3435 \item {start }{a starting estimate for the fitted table. This optional
3536 argument is important for incomplete tables with structural zeros
@@ -38,13 +39,13 @@ loglin(table, margin, start = rep(1, length(table)), fit = FALSE,
3839 the others can be taken as one. }
3940 \item {fit }{a logical indicating whether the fitted values should be
4041 returned. }
41- \item {eps }{maximum deviation allowed between observed and fitted
42- margins. }
42+ \item {eps }{bound for allowed deviation ( largest absolute value of the
43+ difference ) between observed and fitted margins. }
4344 \item {iter }{maximum number of iterations. }
4445 \item {param }{a logical indicating whether the parameter values should
4546 be returned. }
4647 \item {print }{a logical. If \code {TRUE }, the number of iterations and
47- the final deviation are printed. }
48+ the final deviation ( if there were any iterations ) are printed. }
4849}
4950\value {
5051 A list with the following components.
@@ -54,7 +55,7 @@ loglin(table, margin, start = rep(1, length(table)), fit = FALSE,
5455 adjustment for structural zeros. }
5556 \item {margin }{list of the margins that were fit. Basically the same
5657 as the input \code {margin }, but with numbers replaced by names
57- where possible. }
58+ where possible. Will be \ code { NULL } if the input is. }
5859 \item {fit }{An array like \code {table } containing the fitted values.
5960 Only returned if \code {fit } is \code {TRUE }. }
6061 \item {param }{A list containing the estimated parameters of the
0 commit comments