ropensci / EDIutils

An API Client for the Environmental Data Initiative Repository
https://docs.ropensci.org/EDIutils/
Other
10 stars 2 forks source link

add vignette to get the newest version of a dataset #46

Closed cgries closed 11 months ago

cgries commented 1 year ago

Hilary Dugan suggested to write a vignette the describes the filter="newest" functionality in some functions.

clnsmth commented 12 months ago

Thanks for relaying this suggestion @cgries.

Hi @hdugan! Did you have anything specific in mind?

hdugan commented 12 months ago

So this came up because Corinna told me about the functionality and I had no idea it existed (and it's great). However, reading through the vignette and examples it still took me a a bit of time to figure out how to implement it.

Here's my code where I pull the most recent data for a shiny app https://github.com/hdugan/NTLviewer/blob/master/server.R

I was thinking a simple example along those lines would be helpful for someone trying to do the same thing.

clnsmth commented 12 months ago

Thanks for the inspiration, @hdugan.

I completely agree that EDIutils is currently putting too much burden on users to discover and make sense of this feature.

To address this issue:

  1. Prominent Example in README: We could place a relevant example front and center in the package README. This would provide users with a quick and clear understanding of how to use this feature without diving into details.
  2. In-Depth Explanation in Vignette: Additionally, we can include the same example in the Search and Access vignette, where there's more space to explain the nuances of data package versioning, such as why data entity identifiers cannot be reliably reused across versions (e.g., because they almost always change).

Thoughts?

hdugan commented 12 months ago

I think both sound great, although I'm not sure how common this use-case is. If you all deem it rare, in that most people know what version they want, it could just be in the vignette.

clnsmth commented 11 months ago

Hi @hdugan. I've added a section to the 'Search and Access' vignette to demonstrate this. Would you mind taking a look when you have a minute?

https://github.com/ropensci/EDIutils/pull/50/commits/41c63995a0660539bbc81651a6721b6ea7e13ede

Does it make sense?

hdugan commented 11 months ago

Yeah looks great, and good considerations that you've added.