summary-methods: Summarize the Design Properties

Description Usage Arguments Details Value Note See Also Examples

Description

Methods to summarize the design properties of an object, by printing the summary of each key matrix.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
## S4 method for signature 'designkey'
summary(object, show="dtbw", save="k", ...)

## S4 method for signature 'keymatrix'
summary(object, fact, block,  show="dtbw", save="k", ...)

## S4 method for signature 'keyring'
summary(object, show="tbw",save ="kw", ...)

## S4 method for signature 'listofdesignkeys'
summary(object, show="tbw", save="kw", ...)

## S4 method for signature 'listofkeyrings'
summary(object,  show="tbw",  save="kw", ...)

## S4 method for signature 'planordesign'
summary(object, fact, block,  show="dtbw", save="k", ...)

Arguments

object

an object of the class.

fact

a character or numeric vector of parent factor names for the columns of the object.

block

a logical vector to identify the columns of the object associated with a block factor

show

an optional string to identify the type of information to display. The recognized letters are: ‘d’ for the design keys matrices, ‘t’ for the treatment effects confounded with the mean, ‘b’ for the block-and-treatment effects confounded with the mean, ‘w’ for the weight profiles.

save

an optional string to identify the type of information to return. The recognized letters are: ‘k’ for the kernel matrices, ‘w’ for the weight profiles of the treatment effects confounded with the mean.

...

ignored.

Details

The amount of display depends on the value of the argument show, and the type of returned information depends on the value of the argument save.

Value

A list. See Details
Information returned for each key matrix depends on the argument save.

Note

An R option named planor.max.print is set. It is equal to the number of printed rows and columns in the display of planor matrices. Default is 20. You can change its value by using the function options() (see ?options).

See Also

Classes where this method applies: designkey, keymatrix, keyring, listofdesignkeys, listofkeyrings, planordesign

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
### Creation of a listofdesignkeys object
K0 <- planor.designkey(factors=c("R","C","U","A","B1","B2"),
  nlevels=c(3,2,2,3,2,2), model=~R*C + (A+B1+B2)^2, estimate=~A:B1+A:B2,
  nunits=12, base=~R+C+U, max.sol=2)
### Method summary applied on a keymatrix object
r <- summary(K0[[1]][[1]])
### Method summary applied on a designkey  object
summary(K0[1], save=NULL)
### Method summary applied on the listofdesignkeys object
r <-summary(K0, show="dt")

### Creation of a listofkeyrings object
K0 <- planor.designkey(factors=c(LETTERS[1:4], "block"), nlevels=rep(3,5),
   model=~block+(A+B+C+D)^2, estimate=~A+B+C+D,
   nunits=3^3, base=~A+B+C, max.sol=2)
### Method summary applied on the keymatrix object
r <-summary(K0[[1]][[1]])
### Method summary applied on the keyring object
r <-summary(K0[[1]])
### Method summary applied on the listofkeyrings object
r <- summary(K0, show="dtb", save ="k")
print(r)

planor documentation built on June 2, 2017, 5:02 p.m.

Search within the planor package
Search all R packages, documentation and source code