add vignette to readme

ropensci · Feb 11, 2024 · 4b95c58 · 4b95c58
1 parent ceafbd6
commit 4b95c58
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 2 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -47,6 +47,20 @@ remotes::install_github("ropensci/rvertnet")
 library('rvertnet')
 ```
 
+## Vignette
+
+View the vignette in your web browser
+
+```{r eval=FALSE}
+browseVignettes("rvertnet")
+```
+
+Or view the vignette in Rstudio
+
+```{r eval=FALSE}
+vignette("rvertnet")
+```
+
 ## Search by term
 
 Search for _Aves_ in the state of _California_, limit to 10 records

diff --git a/README.md b/README.md
@@ -40,6 +40,20 @@ remotes::install_github("ropensci/rvertnet")
 library('rvertnet')
 ```
 
+## Vignette
+
+View the vignette in your web browser
+
+``` r
+browseVignettes("rvertnet")
+```
+
+Or view the vignette in Rstudio
+
+``` r
+vignette("rvertnet")
+```
+
 ## Search by term
 
 Search for *Aves* in the state of *California*, limit to 10 records
@@ -54,7 +68,7 @@ Inspect metadata
 ``` r
 res$meta
 #> $request_date
-#> [1] "2024-02-08T07:42:22.231381"
+#> [1] "2024-02-11T20:57:10.243471"
 #> 
 #> $response_records
 #> [1] 10
@@ -69,7 +83,7 @@ res$meta
 #> [1] 10
 #> 
 #> $last_cursor
-#> [1] "False:Cq8FCooDCtwC9wAAABn_____jIGJmo2LkZqL0o-QjYuek96WkZuah9LNz87M0s_H0s_H_wAA_3RtoKCZi4ygoP8AAP9dno-PmpGYlpGa_wAA_3N0bZaRm5qH_wAA_12biJz_AAD_c3Rtm5CcoJab_wAA_12cnozQkI2R0IqNkdKcnouek5CY0pyejNKQjZHSzs_Pzs7_AAD_c3-cnozQkI2R0IqNkdKcnouek5CY0pyejNKQjZHSzs_Pzs7_AAD__wD-__6MgYmajYuRmovSj5CNi56T3paRm5qH0s3PzszSz8fSz8f_AHRtoKCZi4ygoP8AXZ6Pj5qRmJaRmv8Ac3RtlpGbmof_AF2biJz_AHN0bZuQnKCWm_8AXZyejNCQjZHQio2R0pyei56TkJjSnJ6M0pCNkdLOz8_Ozv8Ac3-cnozQkI2R0IqNkdKcnouek5CY0pyejNKQjZHSzs_Pzs7_AP_-EAohBN0EkB08Gxk5AAAAAOb___9IClAAWgsJqfRpY40nh9IQA2COstK7BRINRG9jdW1lbnRJbmRleBruAShBTkQgKElTICJjdXN0b21lcl9uYW1lIiAiYXBwZW5naW5lIikgKElTICJncm91cF9uYW1lIiAic352ZXJ0bmV0LXBvcnRhbCIpIChJUyAibmFtZXNwYWNlIiAiaW5kZXgtMjAxMy0wOC0wOCIpIChJUyAiaW5kZXhfbmFtZSIgImR3YyIpIChBTkQgKE9SIChRVCAiQXZlcyIgInJ0ZXh0X2NsYXNzIikgKElTICJyYXRvbV9jbGFzcyIgImF2ZXMiKSkgKFFUICJDYWxpZm9ybmlhIiAicnRleHRfc3RhdGVwcm92aW5jZSIpKSk6GQoMKE4gb3JkZXJfaWQpEAEZAAAAAAAA8P9KBQgAQOgH"
+#> [1] "False:Cq8FCooDCtwC9wAAABn_____jIGJmo2LkZqL0o-QjYuek96WkZuah9LNz87M0s_H0s_H_wAA_3RtoKCZi4ygoP8AAP9dno-PmpGYlpGa_wAA_3N0bZaRm5qH_wAA_12biJz_AAD_c3Rtm5CcoJab_wAA_12cnozQkI2R0IqNkdKcnouek5CY0pyejNKQjZHSzs_Pzs7_AAD_c3-cnozQkI2R0IqNkdKcnouek5CY0pyejNKQjZHSzs_Pzs7_AAD__wD-__6MgYmajYuRmovSj5CNi56T3paRm5qH0s3PzszSz8fSz8f_AHRtoKCZi4ygoP8AXZ6Pj5qRmJaRmv8Ac3RtlpGbmof_AF2biJz_AHN0bZuQnKCWm_8AXZyejNCQjZHQio2R0pyei56TkJjSnJ6M0pCNkdLOz8_Ozv8Ac3-cnozQkI2R0IqNkdKcnouek5CY0pyejNKQjZHSzs_Pzs7_AP_-EAoh214v0Zsk1Mk5AAAAAOb___9IClAAWgsJqfRpY40nh9IQA2CK35WkBhINRG9jdW1lbnRJbmRleBruAShBTkQgKElTICJjdXN0b21lcl9uYW1lIiAiYXBwZW5naW5lIikgKElTICJncm91cF9uYW1lIiAic352ZXJ0bmV0LXBvcnRhbCIpIChJUyAibmFtZXNwYWNlIiAiaW5kZXgtMjAxMy0wOC0wOCIpIChJUyAiaW5kZXhfbmFtZSIgImR3YyIpIChBTkQgKE9SIChRVCAiQXZlcyIgInJ0ZXh0X2NsYXNzIikgKElTICJyYXRvbV9jbGFzcyIgImF2ZXMiKSkgKFFUICJDYWxpZm9ybmlhIiAicnRleHRfc3RhdGVwcm92aW5jZSIpKSk6GQoMKE4gb3JkZXJfaWQpEAEZAAAAAAAA8P9KBQgAQOgH"
 #> 
 #> $query_version
 #> [1] "search.py 2016-08-15T16:43+02:00"