ds.summary {dsBaseClient}R Documentation

Generates the summary of an object

Description

Provides some insight about an object. Unlike the similar R function only a limited class of objects can be used as input to reduce the risk of disclosure.

Usage

ds.summary(x = NULL, datasources = NULL)

Arguments

x

a numeric or factor variable

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

The class and size of the object are returned and various other information are also returned depending of the class of the object. Potentially disclosive information such as the minimum and maximum values of numeric vectors are not returned. The summary is given for each study separately.

Value

the returned information depends on the class of the objects.

Author(s)

Gaye, A.

Examples

{

  # load the login data
  data(logindata)

  # login and assign all the variable held in the opal database
  opals <- datashield.login(logins=logindata,assign=TRUE)

  # Example 1: suummary of a numerical variable
  ds.summary(x='D$LAB_TSC')

  # Example 1: suummary of a binary variable
  ds.summary(x='D$GENDER')

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

}

[Package dsBaseClient version 4.1.0 ]