dsqShowQueries: Show all available queries

dsqShowQueriesR Documentation

Show all available queries

Description

Return all the available queries explained and grouped by domain.

Usage

dsqShowQueries(
  force.download = FALSE,
  query_type = c("Assign", "Aggregate"),
  domain = NULL,
  query_name = NULL,
  async = TRUE,
  datasources = NULL
)

Arguments

force.download

a logical, default FALSE. The normal behaviour of this function is to connect to the remote nodes only at the first invocation and cache the results. All subsequent invocations will only access the cache. To force re-donwload of the queries from the remote nodes set this parameter to TRUE.

query_type

a character, one of "Assign" or "Aggregate". Assign: queries whose results cannot be retrieved due to disclosure controls. Their results are loaded in the remote session(s) and made availablle for further processing. Aggregate: queries that retrieve aggregate data, their results are directly returned to the caller.

domain

a character, used to restrict the retrieved queries by domain (a list of all available domains is shown when invoking with domain = NULL)

query_name

a character, restricts the result to one specific query

async

same as in datashield.assign

datasources

same as in datashield.assign. Unlike in datashield.assign, only the first datasource will be used (as the queries are the same on all nodes).

Value

a list containing all the available queries with documentation


sib-swiss/dsQueryLibrary documentation built on Oct. 12, 2023, 10:05 a.m.