opal.variable_summary: Get summary statistics of a variable of a table

View source: R/opal.datasource.R

opal.variable_summaryR Documentation

Get summary statistics of a variable of a table

Description

Get summary statistics of a variable of a table

Usage

opal.variable_summary(
  opal,
  datasource,
  table,
  variable,
  cached = TRUE,
  nature = NULL
)

Arguments

opal

Opal object.

datasource

Name of the datasource.

table

Name of the table in the datasource.

variable

Name of the variable in the table.

cached

Get cached summary if exists. When FALSE, the cached summary is evicted and replaced by the newly calculated one. Default is TRUE.

nature

Force summary nature, independently from the variable. Possible values are: CATEGORICAL, CONTINUOUS, TEMPORAL, GEO, BINARY, UNDETERMINED.

See Also

Other datasource functions: opal.annotate(), opal.annotations(), opal.attribute_values(), opal.datasources(), opal.datasource(), opal.tables(), opal.table(), opal.valueset(), opal.variables(), opal.variable()

Examples

## Not run: 
o <- opal.login('administrator','password', url='https://opal-demo.obiba.org')
opal.variable_summary(o, 'CNSIM', 'CNSIM1', 'GENDER')
opal.logout(o)

## End(Not run)

opalr documentation built on Oct. 6, 2023, 5:08 p.m.