update: Update a minid

Description Usage Arguments Details Value Examples

View source: R/minidtools.R

Description

Only locations, titles, locations, status, and obsoleted_by can be updated.

Usage

1
2
update(id, config = config, new_title = "", new_location = "",
  new_status = "", new_obsoleted_by = "")

Arguments

id

the identifier string of the minid to update (e.g. "ark:/57799/b9j69h" or "minid:b9j69h")

config

a configuration object (see confguration())

new_title

the new title for the object (a string)

new_location

the new location for the object (a string)

new_status

minid status. May be "ACTIVE" or "TOMBSTONE"

new_obsoleted_by

the minid identifier to replace the obsolete minid

Details

NOTE: lookup currently supports minids of the form "ark:/57799/b9j69h" or "mind:b9j69h"

Value

An object of type "minid" or an error if the lookup fails

Examples

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

update(id = "ark:/99999/fk4q53tj2m",
       config = config,
       new_title = "A Better Title!",
       new_location="http://example.com/bar.txt",
       new_status = "TOMBSTONE",
       new_obsoleted_by = "ark:/99999/fk48s5xs8m")


## End(Not run)

bheavner/minid documentation built on Aug. 1, 2020, 9:38 p.m.