summary {opm}R Documentation

Summarise OPMX or MOPMX objects

Description

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

Usage

  ## 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

# OPM method
(x <- summary(vaas_1))
## Class                 OPMD
## From file             ./E. coli DSM
##                       30083T_vim10_7B__1_28_PMX_0_8#30#2010_F_
##                       7B_5.csv
## Hours measured        95.75
## Number of wells       96
## Plate type            Gen III
## Position              7-B
## Setup time            8/30/2010 1:53:08 PM
## Metadata              5
## Aggregated            TRUE
## Discretized           TRUE
stopifnot(is.list(x), is.object(x))
vaas_1 # calls show()
## Class                 OPMD
## From file             ./E. coli DSM
##                       30083T_vim10_7B__1_28_PMX_0_8#30#2010_F_
##                       7B_5.csv
## Hours measured        95.75
## Number of wells       96
## Plate type            Gen III
## Position              7-B
## Setup time            8/30/2010 1:53:08 PM
## Metadata              5
## Aggregated            TRUE
## Discretized           TRUE
# OPMS method
(x <- summary(vaas_4))
## 1
## Class                 OPMD
## From file             ./E. coli DSM
##                       18039_vim10_12B__1_28_PMX_0_8#30#2010_E_12B_5.csv
## Hours measured        95.75
## Number of wells       96
## Plate type            Gen III
## Position              12-B
## Setup time            8/30/2010 1:19:11 PM
## Metadata              5
## Aggregated            TRUE
## Discretized           TRUE
## 
## 2
## Class                 OPMD
## From file             ./E. coli DSM
##                       30083T_vim10_7B__1_28_PMX_0_8#30#2010_F_
##                       7B_5.csv
## Hours measured        95.75
## Number of wells       96
## Plate type            Gen III
## Position              7-B
## Setup time            8/30/2010 1:53:08 PM
## Metadata              5
## Aggregated            TRUE
## Discretized           TRUE
## 
## 3
## Class                 OPMD
## From file             ./P. aeruginosa DSM
##                       1707_vim10_17B__1_28_PMX_0_8#30#2010_D_17B_5.csv
## Hours measured        95.75
## Number of wells       96
## Plate type            Gen III
## Position              17-B
## Setup time            8/30/2010 12:31:46 PM
## Metadata              5
## Aggregated            TRUE
## Discretized           TRUE
## 
## 4
## Class                 OPMD
## From file             ./P. aeruginosa St.
##                       429_vim10_22B__1_28_PMX_0_8#30#2010_C_22B_5.csv
## Hours measured        95.75
## Number of wells       96
## Plate type            Gen III
## Position              22-B
## Setup time            8/30/2010 11:28:54 AM
## Metadata              5
## Aggregated            TRUE
## Discretized           TRUE
## 
## => OPMS object with 4 plates (4 aggregated, 4 discretized) of type 'Gen III', 96 well(s) and about 384 time point(s).
stopifnot(is.list(x), length(x) == 4L, all(sapply(x, is.list)),
  is.object(x))
vaas_4 # calls show()
## 1
## Class                 OPMD
## From file             ./E. coli DSM
##                       18039_vim10_12B__1_28_PMX_0_8#30#2010_E_12B_5.csv
## Hours measured        95.75
## Number of wells       96
## Plate type            Gen III
## Position              12-B
## Setup time            8/30/2010 1:19:11 PM
## Metadata              5
## Aggregated            TRUE
## Discretized           TRUE
## 
## 2
## Class                 OPMD
## From file             ./E. coli DSM
##                       30083T_vim10_7B__1_28_PMX_0_8#30#2010_F_
##                       7B_5.csv
## Hours measured        95.75
## Number of wells       96
## Plate type            Gen III
## Position              7-B
## Setup time            8/30/2010 1:53:08 PM
## Metadata              5
## Aggregated            TRUE
## Discretized           TRUE
## 
## 3
## Class                 OPMD
## From file             ./P. aeruginosa DSM
##                       1707_vim10_17B__1_28_PMX_0_8#30#2010_D_17B_5.csv
## Hours measured        95.75
## Number of wells       96
## Plate type            Gen III
## Position              17-B
## Setup time            8/30/2010 12:31:46 PM
## Metadata              5
## Aggregated            TRUE
## Discretized           TRUE
## 
## 4
## Class                 OPMD
## From file             ./P. aeruginosa St.
##                       429_vim10_22B__1_28_PMX_0_8#30#2010_C_22B_5.csv
## Hours measured        95.75
## Number of wells       96
## Plate type            Gen III
## Position              22-B
## Setup time            8/30/2010 11:28:54 AM
## Metadata              5
## Aggregated            TRUE
## Discretized           TRUE
## 
## => OPMS object with 4 plates (4 aggregated, 4 discretized) of type 'Gen III', 96 well(s) and about 384 time point(s).

[Package opm version 1.3.63 Index]