syn_login: Logs into Synapse.

View source: R/login.R

syn_loginR Documentation

Logs into Synapse.

Description

Wrapper around https://python-docs.synapse.org/build/html/index.html#synapseclient.Synapse.login Username and password authentication is not supported. Recommendation is to store SYNAPSE_AUTH_TOKEN in environment, so login can be used simply as syn_login().

Usage

syn_login(authtoken = Sys.getenv("SYNAPSE_AUTH_TOKEN"))

Arguments

authtoken

Uses SYNAPSE_AUTH_TOKEN environmental variable, or a personal access token (PAT) can be provided.

Examples

## Not run: 
library(nfportalutils)
syn_login()

## End(Not run)

nf-osi/nfportalutils documentation built on Sept. 15, 2024, 2:15 p.m.