ropenscilabs / deposits

R Client for access to multiple data repository services
https://docs.ropensci.org/deposits/
Other
37 stars 3 forks source link

Example metadata does not confirm with expected schema #61

Closed peterdesmet closed 1 year ago

peterdesmet commented 1 year ago

Following the steps in the documentation currently results in an error for me:

metadata <- list (
  title = "New Title",
  abstract = "This is the abstract",
  creator = list ("A. Person", "B. Person")
)
cli <- depositsClient$new (service = "zenodo", sandbox = TRUE, metadata = metadata)
#   instancePath                              schemaPath keyword   type                      message
# 1   /creator/0 #/properties/creator/items/anyOf/0/type    type object               must be object
# 2   /creator/0 #/properties/creator/items/anyOf/1/type    type object               must be object
# 3   /creator/0        #/properties/creator/items/anyOf   anyOf   <NA> must match a schema in anyOf
# 4   /creator/1 #/properties/creator/items/anyOf/0/type    type object               must be object
# 5   /creator/1 #/properties/creator/items/anyOf/1/type    type object               must be object
# 6   /creator/1        #/properties/creator/items/anyOf   anyOf   <NA> must match a schema in anyOf
# Error in validate_dcmi_metadata(metadata) : 
#   Stopping because the DCMI metadata terms listed above do not conform with the expected schema.
mpadge commented 1 year ago

Sorry about that @peterdesmet, the docs hadn't been updated. They now have all examples in the expected form:

metadata <- list (
    title = "New Title",
    abstract = "This is the abstract",
    creator = list (list (name = "A. Person"), list (name = "B. Person"))
)

Thanks for discovering that :+1:

peterdesmet commented 1 year ago

Thanks! While you're at it, I also noticed two typos

Correct to "function":

https://github.com/ropenscilabs/deposits/blob/54b8789b7a5cd6148d30917a7ba41e062ee41ce9/vignettes/deposits.Rmd#L217

Correct to "deposit_fill_metadata()":

https://github.com/ropenscilabs/deposits/blob/54b8789b7a5cd6148d30917a7ba41e062ee41ce9/README.Rmd#L122

mpadge commented 1 year ago

Thanks for finding those! Feel free to PR any other minor (or major :smile:) things you may find at any time.