ropensci / rerddap

R client for working with ERDDAP servers
https://docs.ropensci.org/rerddap
Other
40 stars 14 forks source link

Incomplete example in get started vignette for fun global_search() #112

Open salvafern opened 1 year ago

salvafern commented 1 year ago

Hello there :wave:

I just noticed there is an incomplete example in the get started vignette:

global_search(query, server_list, which_service)
#> Error in check_arg(query, "character"): object 'query' not found

https://docs.ropensci.org/rerddap/reference/global_search.html

But I also saw this error message is hard coded in https://github.com/ropensci/rerddap/blob/55960549c639f053d29ac55350db65c059b720c9/vignettes/rerddap.Rmd#L99 so not sure if this is intentional.

In any case I made a quick fix (https://github.com/salvafern/rerddap/commit/8b6db96bf42202439f87408d6a6daeae9c295f8f), happy to PR if you agree.

Thanks for this great package! Salva

rmendels commented 1 year ago

@salvafern Thanks for pointing out this error. I see the error, I am not good with git would prefer making the change myself directly. Fortunately I am going to be making a new commit to CRAN some time next week. Can you tell me your name and email so I can add you as a contributor? Send it to my work email if you prefer.

And glad you like the package. We make a real effort to allow folks to easily access the data they need in their work.

rmendels commented 1 year ago

@salvafern Looking at this I think originally I meant the R chunk to be set not to execute, but goofed on that, I will likely use your example.

salvafern commented 1 year ago

Info sent by email, thanks!