Variable

class Variable

Variables represent the "columns" in tables (and uploads), and have certain metadata as well as detailed univariate summary statistics associated with them. Use this class to interface with variables and their metadata.

Constructors

Query$list_variables([max_results])	List all variables in a (completed) query's results.
Table$list_variables([max_results])	List all variables in a table.
Upload$list_variables([max_results])	List all variables in a (completed) upload.
Query$variable(variable_name)	Construct a reference to a variable within a completed query based on its (case-insensitive) name.
Table$variable(variable_name)	Construct a reference to a variable within a table based on its (case-insensitive) name.
Upload$variable(variable_name)	Construct a reference to a variable within a completed upload based on its (case-insensitive) name.

Examples

Basics

loadNamespace("redivis")

table <- redivis$organization("Demo")$dataset("iris_species")$table("iris")

variable <- table$variable("sepalLengthCm")

variable$exists() # -> TRUE
variable$get() 

print(variable$properties)

{
	"kind": "variable",
	... (see variable resource definition)
}

print(variable$get_statistics())

{
  "kind": "variableStatistics"
  "status": "completed",
  "count": 150,
  "numDistinct": 35,
  "min": 4.3,
  "max": 7.9,
  "mean": 5.8433333333333355,
  "approxMedian": 0.8280661279778625,
  ...
}

Attributes

properties	A named list containing the API resource representation of the variable. This will only be populated after certain methods are called, particularly the get method, and will otherwise be an empty list.
table	A reference to the Table instance that constructed this variable. Will be NULL if the variable belongs to an upload.

Methods

variable$get()	Gets the variable, after which the properties attribute will be populated according to the variable.get resource definition.
variable$get_statistics()	Gets the variable statistics, returning a named list corresponding the variableStatistics resource definition.
variable$exists()	List all visible datasets owned by the user.
variable$update([label, description, ...])	Update a variable's metadata.