search

hubverse-org / hubDocs

https://hubverse.io
4 stars 5 forks source link

remove static storage of hubensembles vignette #139

Open nickreich opened 1 week ago

nickreich commented 1 week ago

At the very bottom of the left menu there is a link to the hubEnsembles vignette at this page: https://hubverse.io/en/latest/more-info/hubEnsembles-vignette.html

This seems like an inefficient way of storing this vignette. Why are we storing this here and not just linking to the hubEnsembles pkgdown site? I note that hubEnsembles does not have a vignette as part of the package yet (I think one is coming very soon). @lshandross maybe you have more insight about this?

lshandross commented 1 week ago

There is a vignette for the package that you can access using the Get Started link on the pkgdown site. I think that it's listed there instead of under the usual Articles menu because the file name is the same as the package name

micokoch commented 1 week ago

I don't remember the details, but at some point I was asked to include an example workflow which Lucie had built in the hubDocs site. I tried various ways of including it in the site (trying to insert the R Markdown file directly for instance), but ultimately couldn't find a better way than the way it is now. It is easy enough to remove it and link to the Get Started link Li suggested, but first I want to verify that is what you want. Put more clearly:

  1. Should I delete the HubEnsembles vignette page from the hubDocs site? An alternative is to move to the User Guide folder.
  2. Should the link to the vignette here link to the Get Started link instead?

Let me know and I can work on this.

lshandross commented 1 week ago

Alvaro added some updated information above but here's my extended reply to Nick's original comment:

Also, I'm realizing that the "hubEnsembles vignette" linked on the page Nick is referencing is actually more of a general demonstration for loading a local hub using hubData, ensembling with hubEnsembles, and plotting with hubVis, which Lucie made. It's also linked at the bottom of the Using the Modeling Hub page. I think that we should also update this link to either go to where that general vignette lives on the hubData pkgdown site or to the vignette I wrote in the hubverse package (which is the same thing but for cloud data retrieval instead of local). I don't know if we want to link the vignettes specific to hubEnsembles only.