Rename ixquick to startpage (close #15) (#14)

* Bump roxygen version

* Switch from coatless to r-assist

* Add links to websits

* Replace `search_ixquick` with `search_startpage`

* Mark `search_ixquick()` as defunct

* Export new search_startpage functions

* Update readme with `search_startpage()`

* Improve documentation

* Re-render README.md

* Bump package version

* Update news entry

Author: coatless

DESCRIPTION

@@ -1,20 +1,20 @@
 Package: searcher
 Title: Query Search Interfaces 
-Version: 0.0.3
+Version: 0.0.3.9000
 Authors@R: c(person("James", "Balamuta",
                     email = "[email protected]", role = c("aut", "cre"),
                     comment = c(ORCID = "0000-0003-2826-8458")))
 Description: Provides a search interface to look up terms
-    on 'Google', 'Bing', 'ixquick', 'DuckDuckGo', 'StackOverflow', 'GitHub', and 'BitBucket'.
-    Upon searching, a browser window will open with the aforementioned search
-    results.
+    on 'Google', 'Bing', 'DuckDuckGo', 'Startpage', 'StackOverflow', 'GitHub', 
+    and 'BitBucket'. Upon searching, a browser window will open with the 
+    aforementioned search results.
 URL: https://github.com/coatless/searcher
 BugReports: https://github.com/coatless/searcher/issues
 Depends: R (>= 3.0.0)
 License: GPL (>= 2)
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 6.0.1
+RoxygenNote: 6.1.1
 Roxygen: list(markdown = TRUE)
 Suggests: testthat,
     covr

NAMESPACE

@@ -11,5 +11,7 @@ export(search_google)
 export(search_ixquick)
 export(search_site)
 export(search_so)
+export(search_sp)
 export(search_stackoverflow)
+export(search_startpage)
 export(searcher)

NEWS.md

@@ -1,3 +1,11 @@
+# searcher 0.0.3.9000
+
+## Changes
+
+- Renamed search portal `search_ixquick()` to `search_startpage()` due to the 
+  merging of ixquick into startpage. (#15)
+
+
 # searcher 0.0.3
 
 ## Features

R/defunct-functions.R

@@ -0,0 +1,9 @@
+#' Defunct functions in `searcher`
+#'
+#' Functions listed below are no longer included in the `searcher` package
+#'
+#' - [search_ixquick()]: The function binding was removed as the search engine
+#'   name changed to "Startpage". Please use [search_startpage()].
+#'
+#' @name searcher-defunct
+NULL

R/search-functions.R

@@ -4,17 +4,18 @@
 #' up the resulting page in a web browser.
 #'
 #' @param site  Name of site to search on. Supported options:
-#'              `"google"` (default), `"stackoverflow"`, `"github"`, `"bing"`,
-#'              `"bitbucket"`
+#'              `"google"` (default), `"bing"`, `"duckduckgo"`, `"startpage"`,
+#'              `"stackoverflow"`, `"github"`, and `"bitbucket"`.
 #' @param query Contents of string to search. Default is the error message.
 #' @param rlang Search for results written in R. Default is `TRUE`
 #'
 #' @return The generated search URL or an empty string.
 #'
 #' @rdname search_site
 #' @export
-#' @seealso [search_google()], [search_stackoverflow()], [search_github()],
-#'          [search_bing()], [search_bitbucket()], [searcher()]
+#' @seealso [search_google()], [search_bing()], [search_duckduckgo()],
+#'          [search_startpage()], [search_stackoverflow()], [search_github()],
+#'          [search_bitbucket()], [searcher()]
 #' @examples
 #' # Search in a generic way
 #' search_site("r-project", "google")
@@ -28,8 +29,8 @@
 #' # Search DuckDuckGo
 #' search_duckduckgo("R language")
 #'
-#' # Search ixquick
-#' search_ixquick("RStudio IDE")
+#' # Search startpage
+#' search_startpage("RStudio IDE")
 #'
 #' # Search StackOverflow for Convolutions in the r tag
 #' search_stackoverflow("convolutions")
@@ -63,7 +64,8 @@ search_site = function(query,
                          "ddg",
                          "bitbucket",
                          "bb",
-                         "ixquick"
+                         "startpage",
+                         "sp"
                        ),
                        rlang = TRUE) {
   site = tolower(site)
@@ -85,7 +87,8 @@ search_site = function(query,
     duckduckgo     = ,
     # empty case carried below
     ddg            = search_duckduckgo(query, rlang),
-    ixquick        = search_ixquick(query, rlang)
+    startpage      = ,
+    sp             = search_startpage(query, rlang)
   )
 }
 
@@ -120,14 +123,15 @@ searcher = function(site  = c(
   "google",
   "bing",
   "ddg",
+  "sp",
   "so",
   "gh",
   "bb",
   "duckduckgo",
   "stackoverflow",
   "github",
   "bitbucket",
-  "ixquick"
+  "startpage"
 ),
 rlang = TRUE) {
   function(query = geterrmessage(), rlang = rlang) {
@@ -196,25 +200,35 @@ search_ddg = search_duckduckgo
 
 #' @rdname search_site
 #' @export
-#' @section ixquick Search:
-#' The `search_ixquick()` function searches
-#' [ixquick](https://ixquick.com) using:
-#'  \code{https://ixquick.com/do/dsearch?query=<query>}
+search_ixquick = function(query = geterrmessage(), rlang = TRUE) {
+  .Defunct(msg = "ixquick is now startpage, please use `search_startpage()`.")
+}
+
+#' @rdname search_site
+#' @export
+#' @section Startpage Search:
+#' The `search_startpage()` function searches
+#' [startpage](https://startpage.com) using:
+#'  \code{https://startpage.com/do/dsearch?query=<query>}
 #'
-#' For additional details regarding [ixquick](https://ixquick.com)'s
+#' For additional details regarding [startpage](https://startpage.com)'s
 #' search interface please see:
-#'  \url{https://support.ixquick.com/index.php?/Knowledgebase/Article/View/201/0/how-do-i-make-startpage-by-ixquick-my-default-search-engine-in-chrome}
-search_ixquick = function(query = geterrmessage(), rlang = TRUE) {
+#'  \url{https://support.startpage.com/index.php?/Knowledgebase/Article/View/1261/0/add-familystartpagecom-as-the-default-search-engine-in-chrome}
+search_startpage = function(query = geterrmessage(), rlang = TRUE) {
   if (!valid_query(query)) {
     message("Please provide only 1 `query` term that is not empty.")
     return(invisible(""))
   }
 
   query = append_r_suffix(query, rlang = rlang)
 
-  browse_url("https://ixquick.com/do/dsearch?query=", query)
+  browse_url("https://startpage.com/do/dsearch?query=", query)
 }
 
+#' @rdname search_site
+#' @export
+search_sp = search_startpage
+
 ########################### End Search Engines
 
 

README.Rmd

@@ -12,7 +12,10 @@ knitr::opts_chunk$set(
 )
 ```
 
-[![Travis-CI Build Status](https://travis-ci.org/coatless/searcher.svg?branch=master)](https://travis-ci.org/coatless/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)[![Coverage Status](https://img.shields.io/codecov/c/github/coatless/searcher/master.svg)](https://codecov.io/github/coatless/searcher?branch=master)
+[![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)
+[![Coverage Status](https://img.shields.io/codecov/c/github/r-assist/searcher/master.svg)](https://codecov.io/github/r-assist/searcher?branch=master)
 
 # searcher
 
@@ -40,7 +43,7 @@ For the development version, you can opt for:
 ```r
 install.packages("devtools")
 
-devtools::install_github("coatless/searcher")
+devtools::install_github("r-assist/searcher")
 ```
 
 ## Usage
@@ -53,17 +56,20 @@ library(searcher)
 
 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, Bing, ixquick, DuckDuckGo, StackOverflow, GitHub,
-and BitBucket. By default, an appropriate suffix for each platform that ensures
-relevant results to _R_ is appended to all queries. This behavior can be 
-disabled by using `rlang = FALSE`.
+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), 
+[GitHub](https://github.com/search), and [BitBucket](https://bitbucket.com/search).
+By default, an appropriate suffix for each platform that ensures relevant 
+results to _R_ is appended to all queries. This behavior can be disabled by 
+using `rlang = FALSE`.
 
 ```r
 # Searching R project on major search engines
 search_google("R project")
 search_bing("R project")
-search_ixquick("R project")
 search_duckduckgo("R project")                           # or search_ddg(...)
+search_startpage("R project")                            # or search_sp(...)
 
 # Searching for linear regression questions for R and in general
 search_stackoverflow("linear regression")
@@ -84,7 +90,7 @@ search_bitbucket("assertions", rlang = FALSE)            # or search_bb(...)
 `searcher` offers preliminary support for automatically or manually 
 searching errors that are generated in _R_. For more robust error search
 support and to also search warning messages, please use the
-[`errorist`](https://github.com/coatless/errorist) package.
+[`errorist`](https://github.com/r-assist/errorist) package.
 
 ### Automatically 
 
@@ -113,6 +119,7 @@ the last error message as the search query on the desired search portal.
 search_google()
 search_bing()
 search_duckduckgo()    # or search_ddg()
+search_startpage()     # or search_sp()
 search_stackoverflow() # or search_so()
 search_github()        # or search_gh()
 search_bitbucket()     # or search_bb()
@@ -132,7 +139,7 @@ package, which queries an off-site user premade database. Both of these options
 were focused solely on querying _R_ documentation made available by packages.
 Given the nature of errors generally being _undocumented_, neither of these
 approaches could be used. Thus, `searcher` was unintentionally born to
-provide a means for [`errorist`](https://github.com/coatless/errorist), which
+provide a means for [`errorist`](https://github.com/r-assist/errorist), which
 contains a robust way to automatically searching errors and warnings.
 
 # Special Thanks

README.md

@@ -2,10 +2,12 @@
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
 [![Travis-CI Build
-Status](https://travis-ci.org/coatless/searcher.svg?branch=master)](https://travis-ci.org/coatless/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)[![Coverage
-Status](https://img.shields.io/codecov/c/github/coatless/searcher/master.svg)](https://codecov.io/github/coatless/searcher?branch=master)
+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)
+[![Coverage
+Status](https://img.shields.io/codecov/c/github/r-assist/searcher/master.svg)](https://codecov.io/github/r-assist/searcher?branch=master)
 
 # searcher
 
@@ -34,7 +36,7 @@ For the development version, you can opt for:
 ``` r
 install.packages("devtools")
 
-devtools::install_github("coatless/searcher")
+devtools::install_github("r-assist/searcher")
 ```
 
 ## Usage
@@ -47,18 +49,22 @@ library(searcher)
 
 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, Bing, ixquick,
-DuckDuckGo, StackOverflow, GitHub, and BitBucket. By default, an
-appropriate suffix for each platform that ensures relevant results to
-*R* is appended to all queries. This behavior can be disabled by using
-`rlang = FALSE`.
+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),
+[GitHub](https://github.com/search), and
+[BitBucket](https://bitbucket.com/search). By default, an appropriate
+suffix for each platform that ensures relevant results to *R* is
+appended to all queries. This behavior can be disabled by using `rlang =
+FALSE`.
 
 ``` r
 # Searching R project on major search engines
 search_google("R project")
 search_bing("R project")
-search_ixquick("R project")
 search_duckduckgo("R project")                           # or search_ddg(...)
+search_startpage("R project")                            # or search_sp(...)
 
 # Searching for linear regression questions for R and in general
 search_stackoverflow("linear regression")
@@ -78,7 +84,7 @@ search_bitbucket("assertions", rlang = FALSE)            # or search_bb(...)
 `searcher` offers preliminary support for automatically or manually
 searching errors that are generated in *R*. For more robust error search
 support and to also search warning messages, please use the
-[`errorist`](https://github.com/coatless/errorist) package.
+[`errorist`](https://github.com/r-assist/errorist) package.
 
 ### Automatically
 
@@ -109,6 +115,7 @@ search portal.
 search_google()
 search_bing()
 search_duckduckgo()    # or search_ddg()
+search_startpage()     # or search_sp()
 search_stackoverflow() # or search_so()
 search_github()        # or search_gh()
 search_bitbucket()     # or search_bb()
@@ -129,7 +136,7 @@ an off-site user premade database. Both of these options were focused
 solely on querying *R* documentation made available by packages. Given
 the nature of errors generally being *undocumented*, neither of these
 approaches could be used. Thus, `searcher` was unintentionally born to
-provide a means for [`errorist`](https://github.com/coatless/errorist),
+provide a means for [`errorist`](https://github.com/r-assist/errorist),
 which contains a robust way to automatically searching errors and
 warnings.