check_genie_access: Check Access to GENIE Data

View source: R/synapse_authentication.R

check_genie_accessR Documentation

Check Access to GENIE Data

Description

Check Access to GENIE Data

Usage

check_genie_access(
  username = NULL,
  password = NULL,
  pat = NULL,
  check_consortium_access = FALSE
)

Arguments

username

'Synapse' username. If NULL, package will search package environment for "username".

password

'Synapse' password. If NULL, package will search package environment for "password".

pat

'Synapse' Personal Access Token. If NULL, package will search package environment for "pat".

check_consortium_access

Specifies whether access to GENIE BPC consortium data releases (vs. public data releases) is checked. Default is FALSE, indicating that access to GENIE BPC public data releases is checked instead.

Value

A success message if you are able to access GENIE BPC data; otherwise an error

Author(s)

Karissa Whiting

Examples

## Not run: 
# if credentials are saved:
check_genie_access()

## End(Not run)

genieBPC documentation built on Sept. 11, 2024, 8:29 p.m.