Search Pattern Vignette (#18)

* Add search pattern vignette * Touch up README * Add vignette bullet * Clean up for release * Ignore inst/doc * Bump to release * Let's not try to inline evaluate `r programming`... * Rename section heading * Add a usage overview * Improve note on contributions * Let's try to shorten the URL (e.g. drop trends) * Update cran submission comments. * Improve ordering * Move badges underneath repo name * Improve installation instructions * Fix website ordering to match with supported sites. * Change headers * Add a section that links out to current users of the package. * Reknit README
coatless-rpkg · Jul 5, 2019 · 4e67e4b · 4e67e4b
1 parent 53700a8
commit 4e67e4b
Show file tree

Hide file tree

Showing 8 changed files with 207 additions and 48 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 .Rhistory
 .RData
 .DS_Store
+inst/doc
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: searcher
 Title: Query Search Interfaces 
-Version: 0.0.3.9200
+Version: 0.0.4
 Authors@R: c(
              person("James", "Balamuta",
                     email = "[email protected]", 
@@ -20,5 +20,9 @@ Encoding: UTF-8
 LazyData: true
 RoxygenNote: 6.1.1
 Roxygen: list(markdown = TRUE)
-Suggests: testthat,
-    covr
+Suggests: 
+    testthat,
+    covr,
+    knitr,
+    rmarkdown
+VignetteBuilder: knitr
diff --git a/NEWS.md b/NEWS.md
@@ -1,10 +1,11 @@
-# searcher 0.0.3.9200
+# searcher 0.0.4
 
 ## Features
 
 - Added search portal:
     - `search_rstudio_community()` or `search_rscom()`: Searches on [RStudio Community](https://community.rstudio.com/search). 
       (#13, #17)
+- Added vignette on search patterns (#18).
 
 ## Changes
 
@@ -15,7 +16,7 @@
 
 ## Deployment
 
-- Improve Travis CI testing deployments by testing across an array and using
+- Improved TravisCI testing deployments by testing across an array and using
   all CPUs allotted to build the container. (#16)
 - Modify thresholding for code coverage rejections. (#16)
 

diff --git a/README.Rmd b/README.Rmd
@@ -12,30 +12,34 @@ knitr::opts_chunk$set(
 )
 ```
 
+# searcher
+
 <!-- badges: start -->
 [![Travis-CI Build Status](https://travis-ci.org/r-assist/searcher.svg?branch=master)](https://travis-ci.org/r-assist/searcher)
 [![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/searcher)](http://www.r-pkg.org/pkg/searcher)
 [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/searcher)](https://cran.r-project.org/package=searcher)
 [![Codecov test coverage](https://codecov.io/gh/r-assist/searcher/branch/master/graph/badge.svg)](https://codecov.io/gh/r-assist/searcher?branch=master)
 <!-- badges: end -->
 
-# searcher
-
 The goal of `searcher` is to provide a search interface directly inside of _R_.
-For example, within _R_, it is possible to look up  `rcpp example numeric vector` 
-or `ggplot2 fix axis labels` without having to
-open a browser, go to a search site, and type the query. By default, 
-the search functions automatically search the last error on call if no
-query is specified.
+For example, to look up  `rcpp example numeric vector` 
+or `ggplot2 fix axis labels` call one of the `search_*()` functions to
+automatically have a web browser open, go to a search site, and type the query. 
+By default, the search functions will attempt to search the last error on call 
+if no query is specified.
 
 ![](https://i.imgur.com/Zq2rg6G.gif)
 
 ## Installation
 
-The `searcher` package is available on both CRAN and GitHub. The CRAN
-version is considered stable while the GitHub version is in a state of
-development and may break. You can install the stable version of the
-`searcher` package with:
+The `searcher` package is available on both 
+[CRAN](https://CRAN.R-project.org/package=searcher) and 
+[GitHub](https://github.com/r-assist/searcher). The 
+[CRAN](https://CRAN.R-project.org/package=searcher)
+version is considered stable while the [GitHub](https://github.com/r-assist/searcher) 
+version is in a state of development and may break. 
+
+You can install the stable version of the `searcher` package with:
 
 ```r
 install.packages("searcher")
@@ -44,8 +48,7 @@ install.packages("searcher")
 For the development version, you can opt for:
 
 ```r
-install.packages("devtools")
-
+if(!requireNamespace("devtools")) { install.packages("devtools") }
 devtools::install_github("r-assist/searcher")
 ```
 
@@ -58,7 +61,7 @@ library(searcher)
 ## Search Terms
 
 The `search_*()` functions can be used to search a query directly from _R_ on
-major search engines, code repositories, and help websites. The following search
+major search engines, programming help websites, and code repositories. The following search
 platforms are supported: [Google](https://google.com), [Bing](https://www.bing.com/),
 [DuckDuckGo](https://duckduckgo.com/), [Startpage](https://www.startpage.com/en/),
 [StackOverflow](https://stackoverflow.com/search), 
@@ -135,7 +138,7 @@ search_bitbucket()         # or search_bb()
 ```
 
 
-# Motivation
+## Motivation
 
 The idea for `searcher` began as a project to automatically search errors and
 warnings that occurred while working with _R_ after a conversation 
@@ -151,12 +154,34 @@ approaches could be used. Thus, `searcher` was unintentionally born to
 provide a means for [`errorist`](https://github.com/r-assist/errorist), which
 contains a robust way to automatically searching errors and warnings.
 
-# Special Thanks
+### Special Thanks
 
 - [Dirk Eddelbuettel](http://dirk.eddelbuettel.com) for starting the discussion
   on [XKCD Comic 1185: Ineffective Sorts](https://xkcd.com/1185/).
 - [Barry Rowlingson](http://barry.rowlingson.com) for remarks about functionality.
 
-# License
+### Publicity
+
+On the [`#rstats`-twitter verse](https://twitter.com/search?q=%23rstats), `searcher` has been positively received by
+community members.
+
+> R package "searcher" that automatically searches Stackoverflow for error that
+> you just saw in the console. Cool package, especially for those who learn R :)
+> https://github.com/coatless/searcher ... #r #rlang #rstats #rstudio
+>
+> --- [Paweł Przytuła](https://twitter.com/pawel_appsilon/status/1109545516264841216) 
+> March 23th, 2019. ~292 Retweets and 876 likes
+
+> Did you know, using "searcher" package, you could automatically to
+> search stackoverflow, google, GitHub and many more sites for errors,
+> packages or topics. #rstats
+>
+> --- [Shakirah Nakalungi](https://twitter.com/cynthia_kyra) June 29th, 2019, when she was [Rotating Curator for the "We are R-Ladies" twitter account](https://twitter.com/WeAreRLadies/status/1144921174251581440).
+> ~144 Retweets and 544 likes
+
+Please let us know via an [issue ticket](https://github.com/r-assist/searcher/issues/new)
+about how you are using `searcher`.
+
+## License
 
 GPL (>= 2)
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
+# searcher
+
 <!-- badges: start -->
 
 [![Travis-CI Build
@@ -12,23 +14,26 @@ downloads](http://cranlogs.r-pkg.org/badges/searcher)](http://www.r-pkg.org/pkg/
 coverage](https://codecov.io/gh/r-assist/searcher/branch/master/graph/badge.svg)](https://codecov.io/gh/r-assist/searcher?branch=master)
 <!-- badges: end -->
 
-# searcher
-
 The goal of `searcher` is to provide a search interface directly inside
-of *R*. For example, within *R*, it is possible to look up `rcpp example
-numeric vector` or `ggplot2 fix axis labels` without having to open a
-browser, go to a search site, and type the query. By default, the search
-functions automatically search the last error on call if no query is
-specified.
+of *R*. For example, to look up `rcpp example numeric vector` or
+`ggplot2 fix axis labels` call one of the `search_*()` functions to
+automatically have a web browser open, go to a search site, and type the
+query. By default, the search functions will attempt to search the last
+error on call if no query is specified.
 
 ![](https://i.imgur.com/Zq2rg6G.gif)
 
 ## Installation
 
-The `searcher` package is available on both CRAN and GitHub. The CRAN
-version is considered stable while the GitHub version is in a state of
-development and may break. You can install the stable version of the
-`searcher` package with:
+The `searcher` package is available on both
+[CRAN](https://CRAN.R-project.org/package=searcher) and
+[GitHub](https://github.com/r-assist/searcher). The
+[CRAN](https://CRAN.R-project.org/package=searcher) version is
+considered stable while the
+[GitHub](https://github.com/r-assist/searcher) version is in a state of
+development and may break.
+
+You can install the stable version of the `searcher` package with:
 
 ``` r
 install.packages("searcher")
@@ -37,8 +42,7 @@ install.packages("searcher")
 For the development version, you can opt for:
 
 ``` r
-install.packages("devtools")
-
+if(!requireNamespace("devtools")) { install.packages("devtools") }
 devtools::install_github("r-assist/searcher")
 ```
 
@@ -51,9 +55,10 @@ library(searcher)
 ## Search Terms
 
 The `search_*()` functions can be used to search a query directly from
-*R* on major search engines, code repositories, and help websites. The
-following search platforms are supported: [Google](https://google.com),
-[Bing](https://www.bing.com/), [DuckDuckGo](https://duckduckgo.com/),
+*R* on major search engines, programming help websites, and code
+repositories. The following search platforms are supported:
+[Google](https://google.com), [Bing](https://www.bing.com/),
+[DuckDuckGo](https://duckduckgo.com/),
 [Startpage](https://www.startpage.com/en/),
 [StackOverflow](https://stackoverflow.com/search), [RStudio
 Community](https://community.rstudio.com/search),
@@ -130,7 +135,7 @@ search_github()            # or search_gh()
 search_bitbucket()         # or search_bb()
 ```
 
-# Motivation
+## Motivation
 
 The idea for `searcher` began as a project to automatically search
 errors and warnings that occurred while working with *R* after a
@@ -149,14 +154,42 @@ provide a means for [`errorist`](https://github.com/r-assist/errorist),
 which contains a robust way to automatically searching errors and
 warnings.
 
-# Special Thanks
+### Special Thanks
 
   - [Dirk Eddelbuettel](http://dirk.eddelbuettel.com) for starting the
     discussion on [XKCD Comic 1185: Ineffective
     Sorts](https://xkcd.com/1185/).
   - [Barry Rowlingson](http://barry.rowlingson.com) for remarks about
     functionality.
 
-# License
+### Publicity
+
+On the [`#rstats`-twitter
+verse](https://twitter.com/search?q=%23rstats), `searcher` has been
+positively received by community members.
+
+> R package “searcher” that automatically searches Stackoverflow for
+> error that you just saw in the console. Cool package, especially for
+> those who learn R :) <https://github.com/coatless/searcher> … \#r
+> \#rlang \#rstats \#rstudio
+> 
+> — [Paweł
+> Przytuła](https://twitter.com/pawel_appsilon/status/1109545516264841216)
+> March 23th, 2019. \~292 Retweets and 876 likes
+
+> Did you know, using “searcher” package, you could automatically to
+> search stackoverflow, google, GitHub and many more sites for errors,
+> packages or topics. \#rstats
+> 
+> — [Shakirah Nakalungi](https://twitter.com/cynthia_kyra) June 29th,
+> 2019, when she was [Rotating Curator for the “We are R-Ladies” twitter
+> account](https://twitter.com/WeAreRLadies/status/1144921174251581440).
+> \~144 Retweets and 544 likes
+
+Please let us know via an [issue
+ticket](https://github.com/r-assist/searcher/issues/new) about how you
+are using `searcher`.
+
+## License
 
 GPL (\>= 2)
diff --git a/cran-comments.md b/cran-comments.md
@@ -1,18 +1,20 @@
 ## Test environments
-* local OS X install, R 3.5.0
-* ubuntu 12.04 (on travis-ci), R 3.5.0
-* win-builder (devel and release)
+
+- local OS X install, R 3.6.0
+- ubuntu 14.04 (on travis-ci), R 3.6.0
+- win-builder (devel and release)
 
 ## R CMD check results
 
-0 errors | 0 warnings | 1 note
+0 errors | 0 warnings | 0 note
 
-* This is a new release.
+- There were no notes associated with this release.
 
 ## Reverse dependencies
 
-There is one reverse dependency:
+There are two reverse dependencies:
 
 - `errorist`
+- `SemNetCleaner`
 
-This reverse dependency built cleanly.
+These reverse dependency built cleanly.
diff --git a/vignettes/.gitignore b/vignettes/.gitignore
@@ -0,0 +1,2 @@
+*.html
+*.R