ds.DANGERdmtEXTRACT {dsDangerClient}R Documentation

DANGER function returning data.frame, Matrix or tibble (DMT) from processing servers to clientside

Description

Copies a DMT from data servers to clientside.

Usage

ds.DANGERdmtEXTRACT(
  dfName = NULL,
  dfClass = "df",
  extract.study.specific = TRUE,
  extract.all.studies.combined = TRUE,
  datasources = NULL
)

Arguments

dfName

is a character string that specifies the name of the DMT to be copied from the serverside to the clientside

dfClass

is an optional character string specifying that, once the serverside dmt has been returned to the clientside, you force ds.DANGERdmtEXTRACT to configure it as a 'data.frame' 'matrix' or 'tibble' with aliases 'df', 'mat' and 'tbl'. If no value is specified it treats the incoming dmt as a data.frame.

extract.study.specific

logical defaulted to TRUE which means that the dmt from each processing source will be combined and returned as a single object. If FALSE this will not be returned. If the <extract.study.specific> and the <extract.all.studies.combined> arguments are both TRUE separate and combined dmts will be returned.

extract.all.studies.combined

logical defaulted to TRUE which means that the dmts from each processing source will be returned as a separate object. If FALSE these will not be returned

datasources

specifies the particular 'connection object(s)' to use.

Details

ds.DANGERdmtEXTRACT calling serverside aggregate function DANGERdmtEXTRACTDS. DANGER FUNCTION: must not be installed on data processing servers holding real data. ONLY TO BE USED FOR DEVELOPMENT PURPOSES

Value

the serverside dmt specified by name dfName as a data.frame/matrix/tibble on the clientside.

Author(s)

Paul Burton for DataSHIELD Development Team - 4th June, 2021

[Package dsDangerClient version 6.2.0 ]