rds.select: Select

In mtna/rds-r: Rich Data Services

Select

Description

The rds.select(dataProduct) method is used to access the record level data of the data product. In the explorer and through the API the total number of cells is limited to 10000 cells. This is done to keep a small and manageable amount of information going over the network. Be aware that by default the select method will perform numerous calls to build up a complete dataset. If this is not desired remember to set autoPage=FALSE.

Usage

rds.select(
  dataProduct,
  limit = NULL,
  offset = NULL,
  cols = NULL,
  colLimit = NULL,
  colOffset = NULL,
  count = FALSE,
  orderby = NULL,
  weights = NULL,
  where = NULL,
  inject = FALSE,
  autoPage = TRUE,
  apiKey = NULL
)

Arguments

dataProduct	The dataProduct whose data is desired.
limit	Specifies the number of records to return.
offset	Specifies the starting index of the records.
cols	The columns to select, these should be specified in the appropriate RDS syntax.
colLimit	Specifies the limit of classifications that should be returned
colOffset	Specifies the starting index of the classifications to be returned
count	Specifies that the total count of records in the dataProduct should be included in the info section.
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 how to subset the records based on variable values.
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
autoPage	If set to true multiple queries will be sent to the RDS server in order to compile the complete data set.
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.