ds.exposome_summary: Generate the summary of a variable of an exposome dataset

In isglobal-brge/dsExposomeClient: DataSHIELD client site Exposome functions

Generate the summary of a variable of an exposome dataset

Description

Generates the summary of a variable (phenotype or exposure) of a server side 'ExposomeSet' object

Usage

ds.exposome_summary(Set, variable, datasources = NULL)

Arguments

Set	character Name of the Exposome Set object on the server side
variable	character Name of the variable to obtain it's summary (numeric or factor variable)
datasources	a list of DSConnection-class (default NULL) objects obtained after login

Value

The function returns a list, the contents of it depend on the variable nature, for numeric variables:
- $class Class of the variable
- $length Number of observations of the variable
- $quantiles & mean Quantiles and mean of the variable

Categorical variable:
- $class Class of the variable
- $length Number of observations of the variable
- $categories Levels of the categorical variable
- $counts of each level Counts for each of the levels

Examples

## Not run: Refer to the package Vignette for examples.

isglobal-brge/dsExposomeClient documentation built on March 5, 2024, 12:26 p.m.