Skip to contents

Get Atlas Connection

Source: R/WebApi.R
getAtlasConnection.Rd

Creates a WebApiConnection object using credentials from secrets.yml

Usage

getAtlasConnection(secretsFilePath = "~/.picard/secrets.yml")

Arguments

secretsFilePath

Character. Path to secrets.yml. Default "~/.picard/secrets.yml".

Value

An R6 class of WebApiConnection containing the ATLAS WebAPI connection details

Details

Store Atlas credentials in ~/.picard/secrets.yml via setupAtlasSecretsKeyring() or editSecrets(). The secrets.yml approach supports three credential formats:

  • Plain strings, !expr keyring::key_get(...), or !expr Sys.getenv(...).