Extractor functions to access components of a permutation design

Simple functions to allow abstracted access to components of a permutation design, for example as returned by how. Whilst many of these are very simple index opertations on a list, using these rather than directly accessing that list allows the internal representation of the permutation design to change without breaking code.

getAllperms(object, ...)
getBlocks(object, ...)
getComplete(object, ...)
getConstant(object, ...)
getCol(object, ...)
getDim(object, ...)
getMake(object, ...)
getMaxperm(object, ...)
getMinperm(object, ...)
getMirror(object, ...)
getNperm(object, ...)
getObserved(object, ...)
getPlots(object, ...)
getRow(object, ...)
getStrata(object, ...)
getType(object, ...)
getWithin(object, ...)
getControl(object, ...)
getHow(object, ...)

# S3 method for class 'how'
getAllperms(object, ...)

# S3 method for class 'how'
getBlocks(object, ...)

# S3 method for class 'how'
getCol(object, which = c("plots", "within"), ...)
# S3 method for class 'Plots'
getCol(object, ...)
# S3 method for class 'Within'
getCol(object, ...)

# S3 method for class 'how'
getComplete(object, ...)

# S3 method for class 'how'
getConstant(object, ...)
# S3 method for class 'Within'
getConstant(object, ...)

# S3 method for class 'how'
getDim(object, which = c("plots", "within"), ...)
# S3 method for class 'Plots'
getDim(object, ...)
# S3 method for class 'Within'
getDim(object, ...)

# S3 method for class 'how'
getMake(object, ...)

# S3 method for class 'how'
getMaxperm(object, ...)

# S3 method for class 'how'
getMinperm(object, ...)

# S3 method for class 'how'
getMirror(object, which = c("plots", "within"), ...)
# S3 method for class 'Plots'
getMirror(object, ...)
# S3 method for class 'Within'
getMirror(object, ...)

# S3 method for class 'how'
getNperm(object, ...)

# S3 method for class 'how'
getObserved(object, ...)

# S3 method for class 'how'
getPlots(object, ...)

# S3 method for class 'how'
getRow(object, which = c("plots", "within"), ...)
# S3 method for class 'Plots'
getRow(object, ...)
# S3 method for class 'Within'
getRow(object, ...)

# S3 method for class 'how'
getStrata(object, which = c("plots", "blocks"),
          drop = TRUE, ...)
# S3 method for class 'Plots'
getStrata(object, drop = TRUE, ...)

# S3 method for class 'how'
getType(object, which = c("plots", "within"), ...)
# S3 method for class 'Plots'
getType(object, ...)
# S3 method for class 'Within'
getType(object, ...)

# S3 method for class 'how'
getWithin(object, ...)

# S3 method for class 'allPerms'
getControl(object, ...)

Arguments

object

An R object to dispatch on.

which

character; which level of restriction to extract information for.

drop

logical; should un-used factor levels be dropped?

...

Arguments passed on to other methods.

Details

These are extractor functions for working with permutation design objects created by how. They should be used in preference to directly subsetting the permutation design in case the internal structure of object changes as permute is developed.

getHow is an alias for getControl; specific methods are implemented for getControl if you are debugging.

Value

These are simple extractor functions and return the contents of the corresponding components of object.

Author

Gavin Simpson

See also

check, a utility function for checking permutation scheme described by how.

Examples

## extract components from a "how" object
hh <- how()
getWithin(hh)
#> $type
#> [1] "free"
#> 
#> $constant
#> [1] FALSE
#> 
#> $mirror
#> [1] FALSE
#> 
#> $ncol
#> NULL
#> 
#> $nrow
#> NULL
#> 
#> $call
#> Within()
#> 
#> attr(,"class")
#> [1] "Within"
getNperm(hh)
#> [1] 199