mint: mint
In bheavner/minid: Working with the BD2K Minimal Viable Identifier

Description Usage Arguments Value Methods (by class) Examples

mint a new minid for a digital object

mint(minid, configuration, test = TRUE)

## S4 method for signature 'minid,configuration'
mint(minid, configuration, test = TRUE)

## S4 method for signature 'list,list'
mint(minid, configuration, test = TRUE)

## S4 method for signature 'minid,list'
mint(minid, configuration, test = TRUE)

## S4 method for signature 'list,configuration'
mint(minid, configuration, test = TRUE)

## S4 method for signature 'character,configuration'
mint(minid, configuration, test = TRUE)

`minid`	minid object or list of fields or file path
`configuration`	configuration object or list of server parameters
`test`	creates names in a test namespace that is removed periodically default = TRUE

a newly minted minid

minid = minid,configuration = configuration: mint a new minid from a minid object
minid = list,configuration = list: mint a new minid from two named lists
minid = minid,configuration = list: mint a new minid from a minid and named list
minid = list,configuration = configuration: mint a new minid from a named list and configuration object
minid = character,configuration = configuration: mint a new minid from a file path and configuration object

## Not run: 
# load config
config <- load_configuration()

# mint minid from file path
mint(minid = "./a_file.RDa", configuration = config, test = TRUE)

# or manually set up config
config <- configuration()
user(config) <- "Jane Example"
email(config) <- "jexample@example.com"
orcid(config) <- "0000-0000-0000-0000" # see http://orch.id
code(config) <- "00000000-0000-0000-0000-000000000000" # see register()

# set up minid object
new_minid <- minid()
checksum_function(new_minid) <- "sha256"
checksum(new_minid) <- digest::digest("./somefile.RDa",
                                      file = TRUE,
                                      algo = "sha256")
titles(new_minid) <- list(title = "An Example Object Title")
locations(new_minid) <- list(link = "http://example.com/somefile.RDa") # optional

# mint the new minid
minted <- mint(minid = new_minid, configuration = config, test = TRUE)

# OR use lists:
computed_checksum <- digest::digest(path = "./somefile.RDa",
                                    file = TRUE,
                                    algo = "sha256")
new_minid = list(
  checksum_function = "sha256",
  checksum = computed_checksum,
  titles = "An Example Object Title",
  locations = "http://example.com/somefile.RDa"
  )

configuration = list(
  server = "http://minid.bd2k.org/minid",
  user(config) <- "Jane Example"
  email(config) <- "jexample@example.com"
  orcid(config) <- "0000-0000-0000-0000", # see http://orch.id
  code(config) <- "00000000-0000-0000-0000-000000000000" # see register()
  )

minted <- mint(minid = new_minid, configuration = config, test = TRUE)

## End(Not run)