rds.variable-class: Rich Data Services Variable
In mtna/rds-r: Rich Data Services

rds.variable-class

R Documentation

Rich Data Services Variable

Description

A variable containg the metadata round a column of data. This will provide information about the variable, what it is, the codes that apply to it and summary statistics.

Slots

id: The variable ID.
name: The variable name.
label: The variable label.
description: The variable description.
questionText: The question that was asked to get a response. This applies to variables whose data was collected through surveys.
dataType: The data type of the variable. This is a harmonized type that is used accross all data sources regardless of how the data is stored in the back. This is the property that should be evaluated if variable information or data needs to be displayed differently based on type.
storageType: The data type that the variable is stored as in the back end data source. This is specific to the source and cannot be counted on to be the same accross all variables on the RDS server.
fixedStorageWidth: The width of the variable in a fixed file.
startPosition: The start position of the variables data in the context of a fixed file.
endPosition: The end position of the variables data in the context of a fixed file.
decimals: The number of decimal places the variables data may have.
classificationId: If the variable has a classification associated with it its ID will be here. This can be used for display or query purposes, however, the classificationUri will result in faster queries so that should be used for querying.
classificationUri: If the variable has a classification associated with it its URI will be here. This can be used for query purposes.
index: The index of the variable in the data product.
reference: Indicates if the variable is a reference. If true, this variable will not contain the full variable metadata, and the variable metadata should be retrieved from the server if more detail about the variable is desired.
isDimension: Indicates if the variable can be used as a dimension or not in tabulations.
isMeasure: Indicates if the variable can be used as a measure or not in tabulations.
isRequired: Indicates if the variable should always be included in the results or not.
isWeight: Indicates if the variable can be used as a weight.
statistics: A list of rds.statistics objects that potentially contains weighted or non weighted summary statistics of the variables values.
frequencies: A list of rds.frequency objects that potentially contains weighted or non weighted frequencies of the variables values.