Documentation update - Githubissues

DataONEorg / rdataone

R package for reading and writing data at DataONE data repositories

http://doi.org/10.5063/F1M61H5X

36 stars 19 forks source link

Documentation update #180

Open gothub opened 7 years ago

gothub commented 7 years ago

The package vignettes need an overhaul. Please add to this issue and specific or general updates that are needed for the vignettes.

dataone-overview.Rmd

explain DataONE conventions and concepts
- object versioning
- object archiving
searching-dataone.Rmd
- example query filtering out obsolete content

amoeba commented 7 years ago

How useful might it be if we showed the user how to replicate the query MetacatUI performs when searching the catalog?

# Search for titles containing "mysubstring"
query(node, list(q = "title:*mysubstring*+AND+formatType:METADATA+AND+-obsoletedBy:*")

mobb commented 7 years ago

IMO, example queries are great! but what kind of user are you designing for?

gothub commented 7 years ago

This query is designed for the informed user that understands a bit about DataONE conventions such as object versioning. This use case cropped up when @amoeba discovered a user description of using query() which illustrates that the result can contain obsoleted pids, which may not be apparent to the user, leading them to download outdated content.

We want to keep query() behaviour as close to raw DataONE API functionality, so I don't think query parameters should be baked into this method.