getSIRIUSToken: Obtains a SIRIUS refresh token

In rickhelmus/patRoon: Workflows for Mass-Spectrometry Based Non-Target Analysis

Obtains a SIRIUS refresh token

Description

This function is used to obtain a SIRIUS refresh token with your login details, which allows generateCompoundsSIRIUS to automatically log in to use e.g. CSI:FingerID.

Usage

getSIRIUSToken(user)

Arguments

user	A character string with the user name/email.

Details

SIRIUS version ‘⁠5⁠’ requires the user to be logged in when using web services such as CSI:FingerID. To allow secure log in by external software tools such as patRoon, a referesh token is needed. This function uses your user name (email) and asks for a password (using getPass) to obtain such a token more easily.

More details for e.g. account creation can be found on https://boecker-lab.github.io/docs.sirius.github.io/account-and-license/.

Value

A character string with the (secret) refresh token or NULL if the input was cancelled.

References

\insertRef

Dhrkop2019patRoon

rickhelmus/patRoon documentation built on April 25, 2024, 8:15 a.m.