ropensci / rnoaa

R interface to many NOAA data APIs
https://docs.ropensci.org/rnoaa
Other
330 stars 84 forks source link

Vignettes? #389

Closed kjschaudt closed 3 years ago

kjschaudt commented 3 years ago

The documentation, such as https://docs.ropensci.org/rnoaa/, says that vignettes are available in the package. Am unable to locate them using vignettes() in rnoaa 1.3.2. Is that available in a development version?

sckott commented 3 years ago

thanks @kjschaudt for your question. Sorry about that. There are vignettes in the docs here https://docs.ropensci.org/rnoaa/ - linked from the pkg landing page https://cloud.r-project.org/web/packages/rnoaa/

I've been removing vignettes from the cran version because cran is checking vignettes for all kinds of things that hold up new version submissions

kjschaudt commented 3 years ago

Scott,

Perhaps, I am missing something.   I've checked https://docs.ropensci.org/rnoaa/ https://docs.ropensci.org/rnoaa/ using both safari and firefox.  Vignettes are listed but there are no active links to any documents from that page.

The vignettes command does not reveal any vignettes in the version of rnoaa downloaded.   Would it be better to try a different source for rnoaa?

Thanks,

Ken

On 5/3/21 4:41 PM, Scott Chamberlain wrote:

thanks @kjschaudt https://github.com/kjschaudt for your question. Sorry about that. There are vignettes in the docs here https://docs.ropensci.org/rnoaa/ https://docs.ropensci.org/rnoaa/ - linked from the pkg landing page https://cloud.r-project.org/web/packages/rnoaa/ https://cloud.r-project.org/web/packages/rnoaa/

I've been removing vignettes from the cran version because cran is checking vignettes for all kinds of things that hold up new version submissions

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/ropensci/rnoaa/issues/389#issuecomment-831553481, or unsubscribe https://github.com/notifications/unsubscribe-auth/AFBHLFMA4QIH5CM4TQEHJJ3TL4KBHANCNFSM4367MUIA.

sckott commented 3 years ago

Did you try "Articles"?

Screen Shot 2021-05-03 at 4 43 33 PM

And "Getting Started" is also a vignette

kjschaudt commented 3 years ago

AHA! I didn't realize that the vignettes were filed under Articles. I followed the link at HELP GETTING STARTED in the main body of the text and looked for a link in the bulleted list below that heading. That will help next time I check rnoaa's capabilities. Any thoughts on extending it to handle the International's Best Track Archive from the NCDC? https://www.ncdc.noaa.gov/ibtracs/index.php?name=ib-v4-access

sckott commented 3 years ago

Are you asking for a IBTRACS vignette?

kjschaudt commented 3 years ago

The documentation on tropical storms seemed too say rnoaa only handles the data in the US databases, not the best track data in the IBTRACS format. Was I mistaken?

sckott commented 3 years ago

We used to have access to IBTRACS in rnoaa, but I removed it last summer as it was too unreliable

kjschaudt commented 3 years ago

Yep. I turned to rnoaa hoping that a reliable solution might be found there.

sckott commented 3 years ago

you can use the code we had for IBTRACS if you want, its openly licensed https://github.com/ropensci/rnoaa/blob/v1.1.0/R/storms.R