configuration: Create an instance of the configuration class

Description Usage Arguments Value Examples

View source: R/AllConstructors.R

Description

Create an instance of the configuration class

Usage

1
2
3
configuration(server = "http://minid.bd2k.org/minid", user = vector(mode =
  "character"), email = vector(mode = "character"), orcid = vector(mode =
  "character"), code = vector(mode = "character"))

Arguments

server

a character string containing the minid server URL (e.g. http://minid.bd2k.org/minid)

user

a character string containing the user name (e.g. "Jane Smith")

email

email address for minid user

orcid

the user's ORCID - see https://orcid.org/ (e.g. "0000-0003-2898-9044")

code

the unique code sent when email address was validated

Value

an instance of the configuration class

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
example_configuration <- configuration(
             server = "http://minid.bd2k.org/minid",
             user = "Jane Smith",
             email = "jsmith@example.com",
             orcid = "0000-0003-2898-9044",
             code = "XXXX-XXX-XXXXX-XXXX-XXXX"
)

## End(Not run)

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