loginCDRC {cdrcR}R Documentation

Login to the CDRC

Description

This function will log in a CDRC user based on the username and password. If you do not have a CDRC user yet, please register on https://apps.cdrc.ac.uk/datasetportal/Identity/Account/Register When you log in an api token is automatically generated, saved in your R environment and loaded, no further action is required from you to access the API.

Usage

loginCDRC(username, password)

Arguments

username

A character-string with your CDRC username.

password

A character-string with your CDRC password.

Details

For safety reasons the API token will expire in 24h. This means that after 24h you need to log in again to generate a new API token which will be self-updated and load.

Value

A response message which confirms the login was successful and how to see the API key.

Examples

## Not run: 
loginCDRC(name='your-username',password='your-password')

## End(Not run)

[Package cdrcR version 0.0.1 Index]