permute (version 0.10-0)

get-methods: Extractor functions to access components of a permutation design

Description

These functions provide abstracted access to components of permutation designs such as those returned by how(). Using them instead of directly indexing the underlying list allows that representation to evolve without breaking user code.

Usage

getAllperms(object, ...)
getBlocks(object, ...)
getComplete(object, ...)
getConstant(object, ...)
getCol(object, ...)
getDim(object, ...)
getMake(object, ...)
getMaxperm(object, ...)
getMinperm(object, ...)
getMirror(object, ...)
getSymmetric(object, ...)
getNperm(object, ...)
getObserved(object, ...)
getPlots(object, ...)
getRow(object, ...)
getStrata(object, ...)
getType(object, ...)
getWithin(object, ...)
getControl(object, ...)
getHow(object, ...)
# S3 method for how
getAllperms(object, ...)
# S3 method for how
getBlocks(object, ...)
# S3 method for how
getCol(object, which = c("plots", "within"), ...)
# S3 method for Plots
getCol(object, ...)
# S3 method for Within
getCol(object, ...)
# S3 method for how
getComplete(object, ...)
# S3 method for how
getConstant(object, ...)
# S3 method for Within
getConstant(object, ...)
# S3 method for how
getDim(object, which = c("plots", "within"), ...)
# S3 method for Plots
getDim(object, ...)
# S3 method for Within
getDim(object, ...)
# S3 method for how
getMake(object, ...)
# S3 method for how
getMaxperm(object, ...)
# S3 method for how
getMinperm(object, ...)
# S3 method for how
getMirror(object, which = c("plots", "within"), ...)
# S3 method for Plots
getMirror(object, ...)
# S3 method for Within
getMirror(object, ...)
# S3 method for how
getSymmetric(object, which = c("plots", "within"), ...)
# S3 method for how
getNperm(object, ...)
# S3 method for Plots
getSymmetric(object, ...)
# S3 method for how
getObserved(object, ...)
# S3 method for how
getPlots(object, ...)
# S3 method for Within
getSymmetric(object, ...)
# S3 method for how
getRow(object, which = c("plots", "within"), ...)
# S3 method for Plots
getRow(object, ...)
# S3 method for Within
getRow(object, ...)
# S3 method for how
getStrata(object, which = c("plots", "blocks"), drop = TRUE, ...)
# S3 method for Plots
getStrata(object, drop = TRUE, ...)
# S3 method for how
getType(object, which = c("plots", "within"), ...)
# S3 method for Plots
getType(object, ...)
# S3 method for Within
getType(object, ...)
# S3 method for how
getWithin(object, ...)
# S3 method for allPerms
getControl(object, ...)

Value

The contents of the corresponding component of object.

Arguments

object

An R object on which to dispatch.

...

Arguments passed to other methods.

which

Character; the level of restriction for which information is required.

drop

Logical; should unused factor levels be dropped?

Author

Gavin Simpson

Details

getHow() is an alias for getControl(); specific getControl() methods are useful when debugging.

See Also

check() checks a permutation design described by how().

Examples

hh <- how()
getWithin(hh)
getNperm(hh)