register: Register a user

Description Usage Arguments Examples

View source: R/minidtools.R

Description

Before using the API to mint or edit a minid, you first need to validate your email address. When you register with register(), the server will send a private code to the email address provided. This code must be supplied for registering or editing minids. For convienece, this code can be added to the config object and saved for future sessions.

Usage

1
register(config = config)

Arguments

config

a configuration object with server, user and email slots filled (mandatory) along with the orcid slot (optional)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 

config <- configuration()
user(config) <- "Jane Example"
email(config) <- "jexample@example.com"
orcid(config) <- "0000-0000-0000-0000" # see https://orcid.org/
register(config)

# then get code from email
code(config) <- "0000000-0000-0000-0000-000000000000"
save_configuration(config)


## End(Not run)

bheavner/minidtools documentation built on Aug. 3, 2020, 4:05 a.m.