rds.tabulate: Tabulate

In mtna/rds-r: Rich Data Services

Tabulate

Description

The rds.tabulate(dataProduct) method is used to create aggregated tables and perform analysis on a data product.

Usage

rds.tabulate(
  dataProduct,
  dimensions,
  measures = NULL,
  limit = NULL,
  offset = NULL,
  orderby = NULL,
  weights = NULL,
  where = NULL,
  totals = TRUE,
  inject = FALSE,
  apiKey = NULL
)

Arguments

dataProduct	The dataProduct whose data is being used in the tabulation.
dimensions	The names of the variables that should be used as dimensions.
measures	The variables that should be used as a measure, will be the count by default.
limit	Specifies the number of records to return.
offset	Specifies the starting index of the records.
orderby	Describes how the results should be ordered.
weights	Ids of numeric variables to weight the data with. This should only be used for variables that are flagged as weights.
where	Describes the subset of records the tabulation should run on.
totals	Specifies if totals should be included. Totals are used to provide roll up information about the counts of dimensions at different levels.
inject	Specifies if metadata should be injected into the data frame. If true and there are classifications available the columns codes will be replaced with code values. Defaults to FALSE
apiKey	The user's apiKey to access the API, if the API is not secured this can be NULL.

mtna/rds-r documentation built on July 30, 2023, 3:25 a.m.