Learn R Programming
rsyncrosim (version 1.2.9)

datasheet: Get a datasheet

Description

Retrieves a SyncroSim datasheet.

Usage

datasheet(
  ssimObject,
  name = NULL,
  project = NULL,
  scenario = NULL,
  summary = NULL,
  optional = FALSE,
  empty = FALSE,
  lookupsAsFactors = TRUE,
  sqlStatement = list(select = "SELECT *", groupBy = ""),
  includeKey = FALSE,
  forceElements = FALSE,
  fastQuery = FALSE
)
# S4 method for list
datasheet(
  ssimObject,
  name = NULL,
  project = NULL,
  scenario = NULL,
  summary = NULL,
  optional = FALSE,
  empty = FALSE,
  lookupsAsFactors = TRUE,
  sqlStatement = list(select = "SELECT *", groupBy = ""),
  includeKey = FALSE,
  forceElements = FALSE,
  fastQuery = FALSE
)
# S4 method for character
datasheet(
  ssimObject,
  name,
  project,
  scenario,
  summary,
  optional,
  empty,
  lookupsAsFactors,
  sqlStatement,
  includeKey,
  fastQuery
)
# S4 method for SsimObject
datasheet(
  ssimObject,
  name = NULL,
  project = NULL,
  scenario = NULL,
  summary = NULL,
  optional = FALSE,
  empty = FALSE,
  lookupsAsFactors = TRUE,
  sqlStatement = list(select = "SELECT *", groupBy = ""),
  includeKey = FALSE,
  forceElements = FALSE,
  fastQuery = FALSE
)

Arguments

ssimObject

SsimLibrary/Project/Scenario, or list of objects. Note that all objects in a list must be of the same type, and belong to the same library.

name

Character or vector of these. Sheet name(s). If NULL, all datasheets in the ssimObject will be returned. Note that setting summary=FALSE and name=NULL pulls all datasheets, which is time consuming and not generally recommended.

project

Character, numeric, or vector of these. One or more Project names, ids or objects. Note that integer ids are slightly faster.

scenario

Character, numeric, or vector of these. One or more Scenario names, ids or objects. Note that integer ids are slightly faster.

summary

Logical. If TRUE returns a dataframe of sheet names and other info. If FALSE returns dataframe or list of dataframes.

optional

Logical. If summary=TRUE and optional=TRUE returns only scope, name and displayName. If summary=FALSE and optional=TRUE returns all of the datasheet's columns, including the optional columns. If summary=TRUE, optional=FALSE, returns only those columns that are mandatory and contain data (if empty=FALSE). Ignored if summary=FALSE, empty=FALSE and lookupsAsFactors=FALSE.

empty

Logical. If TRUE returns empty dataframes for each datasheet. Ignored if summary=TRUE.

lookupsAsFactors

Logical. If TRUE (default) dependencies returned as factors with allowed values (levels). Set FALSE to speed calculations. Ignored if summary=TRUE.

sqlStatement

List returned by sqlStatement(). SELECT and GROUP BY SQL statements passed to SQLite database. Ignored if summary=TRUE.

includeKey

Logical. If TRUE include primary key in table.

forceElements

Logical. If FALSE and name has a single element returns a dataframe; otherwise returns a list of dataframes. Ignored if summary=TRUE.

fastQuery

Logical. If TRUE, the request is optimized for performance. Ignored if combined with summary, empty, or sqlStatement flags.

Value

If summary=TRUE returns a dataframe of datasheet names and other info, otherwise returns a dataframe or list of these.

Details

If summary=TRUE or summary=NULL and name=NULL a dataframe describing the datasheets is returned. If optional=TRUE columns include: scope, package, name, displayName, isSingle, isOutput, data. data only displayed for scenarios. dataInherited and dataSource columns added if a scenario has dependencies. If optional=FALSE columns include: scope, name, displayName. All other arguments are ignored.

Otherwise, for each element in name a datasheet is returned as follows:

  • If lookupsAsFactors=TRUE (default): Each column is given the correct data type, and dependencies returned as factors with allowed values (levels). A warning is issued if the lookup has not yet been set.

  • If empty=TRUE: Each column is given the correct data type. Fast (1 less console command).

  • If empty=FALSE and lookupsAsFactors=FALSE: Column types are not checked, and the optional argument is ignored. Fast (1 less console command).

  • If ssimObject is a list of Scenario or Project objects (output from run(), scenario() or project()): Adds ScenarioID/ProjectID column if appropriate.

  • If scenario/project is a vector: Adds ScenarioID/ProjectID column as necessary.

  • If requested datasheet has scenario scope and contains info from more than one scenario: ScenarioID/ScenarioName/ScenarioParent columns identify the scenario by name, id, and parent (if a result scenario).

  • If requested datasheet has project scope and contains info from more than one project: ProjectID/ProjectName columns identify the project by name and id.