summary: Summarise OPMX or MOPMX objects

Description Usage Arguments Details Value See Also Examples

Description

Generate a summary (which also prints nicely to the screen), or display an OPM, OPMS or MOPMX object on screen.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
  ## S4 method for signature 'CMAT'
show(object) 
  ## S4 method for signature 'MOPMX'
show(object) 
  ## S4 method for signature 'OPMX'
show(object) 

  ## S4 method for signature 'CMAT'
str(object, ...) 
  ## S4 method for signature 'MOPMX'
str(object, ...) 
  ## S4 method for signature 'WMDX'
str(object, ...) 

  ## S4 method for signature 'MOPMX'
summary(object, ...) 
  ## S4 method for signature 'OPM'
summary(object, ...) 
  ## S4 method for signature 'OPMS'
summary(object, ...) 

Arguments

object

OPM, OPMS or MOPMX object.

...

Optional arguments to be included in the output.

Details

Currently the show methods are just wrappers for the summary methods for these objects with an additional call to print. The CMAT method is only for internal use.

Value

For the OPM method, a named list of the class OPM_Summary, returned invisibly. The ‘Metadata’ entry is the number of non-list elements in metadata. For the OPMS method, a list of such lists (one per plate), also returned invisibly, with the class set to OPMS_Summary and some information on the entire object in the attribute ‘overall’.

See Also

base::summary base::formatDL methods::show base::print

Other plotting-functions: ci_plot, heat_map, level_plot, parallel_plot, parallelplot, radial_plot, xy_plot

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# OPM method
(x <- summary(vaas_1))
stopifnot(is.list(x), is.object(x))
vaas_1 # calls show()

# OPMS method
(x <- summary(vaas_4))
stopifnot(is.list(x), length(x) == 4L, all(sapply(x, is.list)),
  is.object(x))
vaas_4 # calls show()

opm documentation built on May 2, 2019, 6:08 p.m.