ds.quantileMean {dsBaseClient}R Documentation

Compute the quantiles

Description

This function calculate the mean and quantile values of a quantitative variable

Usage

ds.quantileMean(x = NULL, type = "combine", datasources = NULL)

Arguments

x

a character, the name of the numeric vector.

type

a character which represent the type of graph to display. If type is set to 'combine' pooled values are displayed and sumamries a returned for each study if type is set to 'split'

datasources

a list of opal object(s) obtained after login in to opal servers; these objects hold also the data assign to R, as dataframe, from opal datasources.

Details

Unlike standard r summary function the minimum and maximum values afe not returned because they are potentially disclosive.

Value

quantiles and statistical mean

Author(s)

Gaye, A.

See Also

ds.mean to compute statistical mean.

ds.summary to generate the summary of a variable.

Examples

{

  # load that contains the login details
  data(logindata)

  # login and assign specific variable(s)
  myvar <- list('LAB_HDL')
  opals <- datashield.login(logins=logindata,assign=TRUE,variables=myvar)

  # Example 1: plot a combined histogram of the variable 'LAB_HDL' - default behaviour
  ds.quantileMean(x='D$LAB_HDL')

  # Example 2: Plot the histograms separately (one per study)
  ds.quantileMean(x='D$LAB_HDL', type='split')

  # clear the Datashield R sessions and logout
  datashield.logout(opals)

}

[Package dsBaseClient version 4.1.0 ]