truncated: Truncated product methods

View source: R/truncated.R

truncatedR Documentation

Truncated product methods

Description

Implements two procedures for truncated versions of Fisher's method\loadmathjax

Usage

truncated(p, ptrunc = NULL, rtrunc = NULL, ...)
## S3 method for class 'truncated'
print(x, ...)
## S3 method for class 'truncated'
summary(object, ...)
## S3 method for class 'truncated'
plot(x, pparams = list(pchs = c(16, 1),
   pcols = c("black", "black")), ...)

Arguments

p \sigvec
ptrunc

Value of \mjseqnp to truncate at. See Details

rtrunc

Which rank \mjseqnp to truncate at. See Details

x

An object of class ‘truncated

object

An object of class ‘truncated

...

Other arguments to be passed through

pparams

A list containing a vector pchs of plotting symbols and a vector pcols of colours

Details

Uses routines from TFisher to implement truncated Fisher \insertCitezaykin07,zhang18metap and from mutoss to implement rank-truncated Fisher \insertCitedudbridge03metap

The print method prints the statistic and its associated \mjseqnp-value. The summary method also prints how many of the input values were actually used. The plot method provides an index plot of the \mjseqnp-values. By default used \mjseqnp-values are plotted with a black filled circle and those not used with a black unfilled circle. The colours and plotting symbols can be changed in pparams. The first element of each vector is for the used \mjseqnp-values and the second for the unused ones.

Value

An object of class ‘truncated’ a list with entries

p

The resultant overall \mjseqnp-value

stat

The test statistic

validp

The input vector with illegal values removed

ptrunc

The \mjseqnp-value used for truncation

trunc

The rank value used for truncation

n

A vector containing incl, the number of valid values included, excl, the number of valid values not used

method

The method used

Note

Only one of ptrunc or rtrunc is returned as appropriate. If the function encounters an error it returns NA for the value of p and gives a warning message. The effect of specifying both ptrunc and rtrunc is undefined.

Author(s)

Michael Dewey

References

\insertAllCited

See Also

ranktruncated, stat.tpm, and p.tpm

Examples

data(dat.metap)
validity <- dat.metap$validity
truncated(validity, ptrunc = 0.5)
truncated(validity, rtrunc = 5)

metap documentation built on Sept. 11, 2024, 6:53 p.m.