Learn R Programming

sdcTable (version 0.20.5)

get.sdcProblem: query `sdcProblem`-objects depending on argument `type`

Description

query sdcProblem-objects depending on argument type

Usage

get.sdcProblem(object, type)
## S3 method for class 'sdcProblem,character':
get.sdcProblem(object, type)

Arguments

object

an object of class sdcProblem

type

a character vector of length 1 defining what to calculate|return|modify. Allowed types are:

Value

information from objects of class sdcProblem depending on argument type
- an object of classdataObj(or NULL) iftypematches 'dataObj'
- an object of classproblemInstance(or NULL) iftypematches 'problemInstance'
- a list (or NULL) if argumenttypematches 'partition' containing the following elements:
  - element 'groups': list with each list-element being a character vector specifying a specific level-group
  - element 'indices': list with each list-element being a numeric vector defining indices of a subtable
  - element 'strIDs': list with each list-element being a character vector defining IDs of a subtable
  - element 'nrGroups': numeric vector of length 1 defining the total number of groups that have to be considered
  - element 'nrTables': numeric vector of length 1 defining the total number of subtables that have to be considered
- a list (or NULL) if argumenttypematches 'innerAndMarginalCellInfo' containing the following elements:
  - element 'innerCells': character vector specifying ID's of inner cells
  - element 'totCells': character vector specifying ID's of marginal cells
  - element 'indexInnerCells': numeric vector specifying indices of inner cells
  - element 'indexTotCells': numeric vector specifying indices of marginal cells
- an object of classdimInfo(or NULL) iftypematches 'dimInfo'
- numeric vector if argumenttypematches 'elapsedTime'
- numeric vector of length 1 if argumenttypematches 'startI' or 'startJ'