RPPADesignParams-class {RPPASPACE}

Class “RPPADesignParams”

Description

The RPPADesignParams class is used to bundle the design parameter set together for easier re-use.

Usage

RPPADesignParams(
	center = FALSE, 
	seriesToIgnore = NULL, 
	majorXDivisions=as.integer(NA), 
	majorYDivisions=as.integer(NA))

is.RPPADesignParams(x)
## S4 method for signature 'RPPADesignParams'
paramString(object, slots, ...)
## S4 method for signature 'RPPA'
plot(x, measure, main, ...)

Arguments

center

logical scalar. If TRUE, then dilution steps are centered around 0.

x

object of class RPPADesignParams (or RPPA in plot method)

seriesToIgnore

object of class list or NULL where list members are numeric Series.Id values to ignore when fitting the data to a curve.

majorXDivisions

integer to describe distance between grid lines on the X axis of the R2 residuals plot. Defaults to 10 if NA or invalid value provided.

majorYDivisions

integer to describe distance between grid lines on the Y axis of the R2 residuals plot. Defaults to 10 if NA or invalid value provided.

object

object of class RPPADesignParams in paramString method

slots

strings specifying RPPADesignParams slotnames to display (for debugging)

main

overall title for plot

measure

character string specifying measure to plot

...

extra arguments for generic or plotting routines

Details

Allows control of some specific controls for how RPPA slides are processed.

Value

The RPPADesignParams generator returns an object of class RPPADesignParams.

The is.RPPADesignParams method returns TRUE if its argument is an object of class RPPADesignParams.

The paramString method returns a character vector, possibly empty but never NULL.

Objects from the Class

Although objects of these classes can be created by a direct call to new, the preferred method is to start with the RPPADesignParams generator, followed by the RPPADesignFromParams function to construct the final object (the RPPADesign generator is directly implemented in this way).

Slots

For RPPADesignParams class:

center:

see corresponding argument above

seriesToIgnore:

see corresponding argument above

majorXDivisions:

see corresponding argument above

majorYDivisions:

see corresponding argument above

Methods

paramString

signature(object = "RPPADesignParams"):
Returns string representation of object.

Warning

The paramString method should not be called by user except for informational purposes. The content and format of the returned string may vary between different versions of this package.

Author(s)

Kevin R. Coombes [e-mail], P. Roebuck [e-mail], James M. Melott [e-mail]

See Also

RPPA

Examples

showClass("RPPADesignParams")
designparams <- designparams <- RPPADesignParams(center=FALSE,
								 seriesToIgnore=list(),
								 majorXDivisions = as.integer(11),
								 majorYDivisions = as.integer(11)
								 )
paramString(designparams)