ds.exposure_histogram: Draw histogram for Exposome Set exposure

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

Draw histogram for Exposome Set exposure

Description

Get a non-disclosive histogram plot for a selected exposure of a server side Exposome Set. The normality results are calculated using a Shapiro-Wilks test for small samples (n < 5000) and with Anderson-Darling test for big samples (n >= 5000).

Usage

ds.exposure_histogram(
  exp,
  exposure,
  show.trans = FALSE,
  ...,
  datasources = NULL
)

Arguments

exp	character Name of the Exposome Set on the server side
exposure	character Name of the exposure of the exposome set to visualize
show.trans	bool (default FALSE) To show (TRUE) or not (FALSE) how the exposure histogram would look like if log/exp/sqrt transformed
...	Parameters passed to the ds.histogram function
datasources	a list of DSConnection-class (default NULL) objects obtained after login

Details

When using the show.trans option, the negative values will be removed for the sqrt-transformation and the 0 values will be removed for the log-transformation. Please be aware the removal of those values could yield a DataSHIELD disclosive problem when creating the subset. For example: If one exposure contains mostly negative values, when removing them to plot the sqrt-transformation the subset creation will fail.

Value

List with plot parameters

Examples

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

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