Print {hyper2} | R Documentation |
Print methods
Description
Print methods for hyper2
and hyper3
objects
Usage
## S3 method for class 'hyper2'
print(x, ...)
## S3 method for class 'hyper3'
print(x, ...)
Arguments
x |
An object of class |
... |
Further arguments, currently ignored |
Details
Used mainly for their side-effect of printing the log-likelihood
function. In the print method, a natural logarithm is indicated with
“log()
”—not “ln()
”—consistent with R
builtin terminology base::log()
.
The hyper2
print method is sensitive to option
give_warning_on_nonzero_power_sum
. If TRUE
, a warning is
issued if the powers have nonzero sum. This is usually what you want
because observations are typically multinomial; a warning indicates
nonzero sum of powers, which should prompt us to check the coding.
Vignette zeropower
gives a discussion of this issue.
Value
Returns the hyper2
or hyper3
object it was sent,
invisibly. Function pnv()
converts a named vector to a
character string that is used in the hyper3
print method.
Author(s)
Robin K. S. Hankin
Examples
data(chess)
chess