search

trashbirdecology / bbsAssistant

An R package for downloading and handling data and information from the North American Breeding Bird Survey.
Creative Commons Zero v1.0 Universal
27 stars 13 forks source link

A couple of typos in the README #56

Closed mbjoseph closed 5 years ago

mbjoseph commented 5 years ago

Describe the bug

There are a couple of minor typos on the README that will raise errors if users follow the instructions as written.

To Reproduce

The instructions under the "Function Descriptions and Vignettes" will lead to two errors:

  1. devtools::build_manual("bbsAssistant) will raise an error, because there is no closing quote before the last parenthesis. This can be simplified to devtools::build_manual(), which by default will use the current package directory.

  2. usethis::build_vignettes() will raise an error because build_vignettes() is not exported by the usethis package. Instead users can devtools::build_vignettes().

Expected behavior

Building the manual and vignettes.

Session info

─ Session info ──────────────────────────────────────
 setting  value                       
 version  R version 3.6.1 (2019-07-05)
 os       Ubuntu 18.04.3 LTS          
 system   x86_64, linux-gnu           
 ui       RStudio                     
 language en_US                       
 collate  en_US.UTF-8                 
 ctype    en_US.UTF-8                 
 tz       America/Denver              
 date     2019-08-27                  

─ Packages ──────────────────────────────────────────
 package      * version date       lib source        
 assertthat     0.2.1   2019-03-21 [1] CRAN (R 3.6.0)
 backports      1.1.4   2019-04-10 [1] CRAN (R 3.6.0)
 bbsAssistant * 1.0.0   2019-08-27 [1] local         
 callr          3.3.1   2019-07-18 [1] CRAN (R 3.6.1)
 cli            1.1.0   2019-03-19 [1] CRAN (R 3.6.0)
 crayon         1.3.4   2017-09-16 [1] CRAN (R 3.6.0)
 desc           1.2.0   2018-05-01 [1] CRAN (R 3.6.0)
 devtools       2.1.0   2019-07-06 [1] CRAN (R 3.6.1)
 digest         0.6.20  2019-07-04 [1] CRAN (R 3.6.1)
 evaluate       0.14    2019-05-28 [1] CRAN (R 3.6.0)
 fs             1.3.1   2019-05-06 [1] CRAN (R 3.6.0)
 glue           1.3.1   2019-03-12 [1] CRAN (R 3.6.0)
 htmltools      0.3.6   2017-04-28 [1] CRAN (R 3.6.0)
 knitr          1.24    2019-08-08 [1] CRAN (R 3.6.1)
 magrittr       1.5     2014-11-22 [1] CRAN (R 3.6.0)
 memoise        1.1.0   2017-04-21 [1] CRAN (R 3.6.0)
 packrat        0.5.0   2018-11-14 [1] CRAN (R 3.6.0)
 pkgbuild       1.0.4   2019-08-05 [1] CRAN (R 3.6.1)
 pkgload        1.0.2   2018-10-29 [1] CRAN (R 3.6.0)
 prettyunits    1.0.2   2015-07-13 [1] CRAN (R 3.6.0)
 processx       3.4.1   2019-07-18 [1] CRAN (R 3.6.1)
 ps             1.3.0   2018-12-21 [1] CRAN (R 3.6.0)
 R6             2.4.0   2019-02-14 [1] CRAN (R 3.6.0)
 Rcpp           1.0.2   2019-07-25 [1] CRAN (R 3.6.1)
 remotes        2.1.0   2019-06-24 [1] CRAN (R 3.6.1)
 rlang          0.4.0   2019-06-25 [1] CRAN (R 3.6.1)
 rmarkdown      1.14    2019-07-12 [1] CRAN (R 3.6.1)
 rprojroot      1.3-2   2018-01-03 [1] CRAN (R 3.6.0)
 rsconnect      0.8.15  2019-07-22 [1] CRAN (R 3.6.1)
 rstudioapi     0.10    2019-03-19 [1] CRAN (R 3.6.0)
 sessioninfo    1.1.1   2018-11-05 [1] CRAN (R 3.6.0)
 testthat       2.2.1   2019-07-25 [1] CRAN (R 3.6.1)
 usethis        1.5.1   2019-07-04 [1] CRAN (R 3.6.1)
 withr          2.1.2   2018-03-15 [1] CRAN (R 3.6.0)
 xfun           0.9     2019-08-21 [1] CRAN (R 3.6.1)
 yaml           2.2.0   2018-07-25 [1] CRAN (R 3.6.0)

[1] /home/max/R/x86_64-pc-linux-gnu-library/3.6
[2] /usr/local/lib/R/site-library
[3] /usr/lib/R/site-library
[4] /usr/lib/R/library

Additional context

I've got a PR in the works to provide a quick fix.