Learn R Programming

permute (version 0.8-4)

permCheck-deprecated: Utility functions for permutation schemes

Description

permCheck provides checking of permutation schemes for validity. permuplot produces a graphical representation of the selected permutation design.

Usage

permCheck(object, control = how())

## S3 method for class 'permCheck': summary(object, \dots)

Arguments

object
an R object. See Details for a complete description, especially for numPerms. For summary.permCheck an object of class "permCheck".
control
a list of control values describing properties of the permutation design, as returned by a call to how.
...
arguments to other methods. For permuplot graphical parameters can be passed to plotting functions, though note that not all parameters will be accepted gracefully at the moment.

Value

  • For permCheck a list containing the maximum number of permutations possible and an object of class "how".

    For permuplot, a plot on the currently active device.

Details

permCheck is a utility functions for working with the new permutation schemes available in shuffle.

permCheck is used to check the current permutation schemes against the object to which it will be applied. It calculates the maximum number of possible permutations for the number of observations in object and the permutation scheme described by control. The returned object contains component control, an object of class "how" suitably modified if permCheck identifies a problem.

The main problem is requesting more permutations than possible with the number of observations and the permutation design. In such cases, nperm is reduced to equal the number of possible permutations, and complete enumeration of all permutations is turned on (control$complete is set to TRUE).

Alternatively, if the number of possible permutations is low, and less than control$minperm, it is better to enumerate all possible permutations, and as such complete enumeration of all permutations is turned on (control$complete is set to TRUE).

See Also

shuffle and how.