Browse Source

Standardize function documentation

* Standardize title format to: "Use base R versions of `tidyverse_package` `function_family` functions"
* Remove default file path from description & standardize description format to: "Creates base R versions of `tidyverse_package` `function_family` functions"
* Revise description of save_as parameter to: "File path and name. Defaults to "R/default_name.R"
* Change package title to: "A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code"
master
Patrick Kennedy 6 years ago
parent
commit
683de380b0
  1. 6
      DESCRIPTION
  2. 2
      R/freebase-package.R
  3. 6
      R/use-detect.R
  4. 4
      R/use-infix-helpers.R
  5. 6
      R/use-isers.R
  6. 7
      R/use-keepers.R
  7. 6
      R/use-mappers.R
  8. 6
      R/use-safely.R
  9. 6
      R/use-tidylite.R
  10. 7
      R/use-walkers.R
  11. 16
      README.Rmd
  12. 19
      README.md
  13. 4
      docs/authors.html
  14. 20
      docs/index.html
  15. 6
      docs/reference/freebase.html
  16. 16
      docs/reference/index.html
  17. 12
      docs/reference/use_detect.html
  18. 6
      docs/reference/use_infix_helpers.html
  19. 12
      docs/reference/use_isers.html
  20. 14
      docs/reference/use_keepers.html
  21. 12
      docs/reference/use_mappers.html
  22. 12
      docs/reference/use_safely.html
  23. 12
      docs/reference/use_tidylite.html
  24. 14
      docs/reference/use_walkers.html
  25. 1
      inst/templates/keepers.R
  26. 2
      man/freebase.Rd
  27. 6
      man/use_detect.Rd
  28. 4
      man/use_infix_helpers.Rd
  29. 6
      man/use_isers.Rd
  30. 7
      man/use_keepers.Rd
  31. 6
      man/use_mappers.Rd
  32. 6
      man/use_safely.Rd
  33. 6
      man/use_tidylite.Rd
  34. 7
      man/use_walkers.Rd

6
DESCRIPTION

@ -1,6 +1,6 @@
Package: freebase
Type: Package
Title: A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code
Title: A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code
Version: 0.1.0
Date: 2018-05-28
Authors@R: c(
@ -8,7 +8,9 @@ Authors@R: c(
comment = c(ORCID = "0000-0001-5670-2640")),
person("Jonathan", "Sidi", email = "yonicd@gmail.com", role = c("aut"),
comment = c(ORCID = "0000-0002-4222-1819")),
person("Malcolm", "Barrett", email = "malcolmbarrett@gmail.com", role = c("ctb"))
person("Malcolm", "Barrett", email = "malcolmbarrett@gmail.com", role = c("ctb")),
person("Patrick", "Kennedy", email = "pkqstr@protonmail.com", role = c("ctb"),
comment = c(ORCID = "0000-0002-5525-3983"))
)
Maintainer: Bob Rudis <bob@rud.is>
Description: The 'tidyverse' is awesome, but can take a bit to compile on systems

2
R/freebase-package.R

@ -1,4 +1,4 @@
#' A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code
#' A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code
#'
#' The 'tidyverse' is awesome, but can take a bit to compile on systems
#' where there are no pre-built binary packages. Methods are provided which use

6
R/use-detect.R

@ -1,11 +1,11 @@
#' Use base-ified equivalents of "detect"-ors
#' Use base R versions of `purrr` `detect` functions
#'
#' * Creates `R/utils-detect.R` with base R pseudo-equivalents for `purrr` `detect` (et al).
#' * Creates base R versions of `purrr` `detect` (et al).
#'
#' These support formula functions (i.e. `~{}`).
#'
#' @md
#' @param save_as Where to save/what to name the file. Defaults to "`R/utils-detect.R`"
#' @param save_as File path and name. Defaults to "`R/utils-detect.R`"
#' @param open if `TRUE`, open the resultant file
#' @export
use_detect <- function(save_as = "R/utils-detect.R", open = TRUE) {

4
R/use-infix-helpers.R

@ -1,9 +1,9 @@
#' Use infix-helpers
#'
#' * Creates `R/utils-infix-helpers.R` with base R `%XXX%` helpers
#' * Creates base R `%xyz%` helpers
#'
#' @md
#' @param save_as Where to save/what to name the file. Defaults to "`R/utils-infix-helpers.R`"
#' @param save_as File path and name. Defaults to "`R/utils-infix-helpers.R`"
#' @param open if `TRUE`, open the resultant file
#' @export
use_infix_helpers <- function(save_as = "R/utils-infix-helpers.R", open = TRUE) {

6
R/use-isers.R

@ -1,9 +1,9 @@
#' Use "is_" functions
#' Use "is_" tester functions
#'
#' * Creates `R/utils-isers.R` filled with `is_...` testors
#' * Creates `is_...` tester functions
#'
#' @md
#' @param save_as Where to save/what to name the file. Defaults to "`R/utils-isers.R`"
#' @param save_as File path and name. Defaults to "`R/utils-isers.R`"
#' @param open if `TRUE`, open the resultant file
#' @export
use_isers <- function(save_as = "R/utils-isers.R", open = TRUE) {

7
R/use-keepers.R

@ -1,12 +1,11 @@
#' Use base-ified equivalents of keep/discard/compact
#' Use base R versions of `purrr` `keep` functions
#'
#' * Creates `R/utils-keepers.R` with base R pseudo-equivalents for `purrr`
#' `keep`/`discard`/`compact`
#' * Creates base R versions of `purrr` `keep` fuctions.
#'
#' These support formula functions (i.e. `~{}`).
#'
#' @md
#' @param save_as Where to save/what to name the file. Defaults to "`R/utils-keepers.R`"
#' @param save_as File path and name. Defaults to "`R/utils-keepers.R`"
#' @param open if `TRUE`, open the resultant file
#' @export
use_keepers <- function(save_as = "R/utils-keepers.R", open = TRUE) {

6
R/use-mappers.R

@ -1,11 +1,11 @@
#' Use base-ified equivalents of 'map'-pers
#' Use base R versions of `purrr` `map` functions
#'
#' * Creates `R/utils-mappers.R` with base R pseudo-equivalents for `purrr` `map`-pers.
#' * Creates base R versions of `purrr` `map` functions.
#'
#' These support formula functions (i.e. `~{}`).
#'
#' @md
#' @param save_as Where to save/what to name the file. Defaults to "`R/utils-mappers.R`"
#' @param save_as File path and name. Defaults to "`R/utils-mappers.R`"
#' @param open if `TRUE`, open the resultant file
#' @export
use_mappers <- function(save_as = "R/utils-mappers.R", open = TRUE) {

6
R/use-safely.R

@ -1,9 +1,9 @@
#' Use base-ified equivalents of "safely"-ifiers
#' Use base R versions of `purrr` `safely` functions
#'
#' * Creates `R/utils-safely.R` with base R pseudo-equivalents for `purrr` `safely` (et al).
#' * Creates base R versions of `purrr` `safely` (et al).
#'
#' @md
#' @param save_as Where to save/what to name the file. Defaults to "`R/utils-safely.R`"
#' @param save_as File path and name. Defaults to "`R/utils-safely.R`"
#' @param open if `TRUE`, open the resultant file
#' @export
use_safely <- function(save_as = "R/utils-safely.R", open = TRUE) {

6
R/use-tidylite.R

@ -1,9 +1,9 @@
#' Use base R versions of `tidyr` `gather`/`spread`/`unite`
#' Use base R versions of `tidyr` functions
#'
#' * Creates `R/utils-tidylite.R` containing `gatherlite()`, `spreadlite()` and `unitelite()`
#' * Creates base R versions of `tidyr` functions
#'
#' @md
#' @param save_as Where to save/what to name the file. Defaults to "`R/utils-tidylite.R`"
#' @param save_as File path and name. Defaults to "`R/utils-tidylite.R`"
#' @param open if `TRUE`, open the resultant file
#' @export
use_tidylite <- function(save_as = "R/utils-tidylite.R", open = TRUE) {

7
R/use-walkers.R

@ -1,12 +1,11 @@
#' Use base-ified equivalents of `walk`/`walk2`
#' Use base R versions of `purrr` `walk` functions
#'
#' * Creates `R/utils-walkers.R` with base R pseudo-equivalents for `purrr`
#' `walk`/`walk2`
#' * Creates base R versions of `purrr` `walk` functions
#'
#' These support formula functions (i.e. `~{}`).
#'
#' @md
#' @param save_as Where to save/what to name the file. Defaults to "`R/utils-walkers.R`"
#' @param save_as File path and name. Defaults to "`R/utils-walkers.R`"
#' @param open if `TRUE`, open the resultant file
#' @export
use_walkers <- function(save_as = "R/utils-walkers.R", open = TRUE) {

16
README.Rmd

@ -4,7 +4,7 @@ output: rmarkdown::github_document
# freebase
A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code
A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code
## Description
@ -22,14 +22,14 @@ Use deliberately and with caution.
The following functions are implemented:
- `use_detect`: Use base-ified equivalents of "detect"-ors (these support `~{}` formula functions)
- `use_detect`: Use base R versions of `purrr` `detect` functions (these support `~{}` formula functions)
- `use_infix_helpers`: Use infix-helpers
- `use_isers`: Use "is_" functions
- `use_keepers`: Use base-ified equivalents of keep/discard/compact (these support `~{}` formula functions)
- `use_mappers`: Use base-ified equivalents of 'map'-pers (these support `~{}` formula functions)
- `use_safely`: Use base-ified equivalents of "safely"-ifiers
- `use_tidylite()`: Use base R versions of 'tidyr' 'gather'/'spread'/'unite'
- `use_walkers`: Use base-ified equivalents of keep/discard/compact (these support `~{}` formula functions)
- `use_isers`: Use "is_" tester functions
- `use_keepers`: Use base R versions of `purrr` `keep` functions (these support `~{}` formula functions)
- `use_mappers`: Use base R versions of `purrr` `map` functions (these support `~{}` formula functions)
- `use_safely`: Use base R versions of `purrr` `safely` functions
- `use_tidylite()`: Use base R versions of core `tidyr` functions
- `use_walkers`: Use base R versions of `purrr` `walk` functions (these support `~{}` formula functions)
## Installation

19
README.md

@ -1,7 +1,7 @@
# freebase
A ‘usethis’-like Package for Base Pseudo-equivalents of ‘tidyverse’ Code
A ‘usethis’-esque Package for Base R Versions of ‘tidyverse’ Code
## Description
@ -19,18 +19,17 @@ Use deliberately and with caution.
The following functions are implemented:
- `use_detect`: Use base-ified equivalents of “detect”-ors (these
support `~{}` formula functions)
- `use_detect`: Use base R versions of `purrr` `detect` functions
(these support `~{}` formula functions)
- `use_infix_helpers`: Use infix-helpers
- `use_isers`: Use “is\_” functions
- `use_keepers`: Use base-ified equivalents of keep/discard/compact
- `use_isers`: Use “is\_” tester functions
- `use_keepers`: Use base R versions of `purrr` `keep` functions
(these support `~{}` formula functions)
- `use_mappers`: Use base-ified equivalents of ‘map’-pers (these
- `use_mappers`: Use base R versions of `purrr` `map` functions (these
support `~{}` formula functions)
- `use_safely`: Use base-ified equivalents of “safely”-ifiers
- `use_tidylite()`: Use base R versions of ‘tidyr’
‘gather’/‘spread’/‘unite’
- `use_walkers`: Use base-ified equivalents of keep/discard/compact
- `use_safely`: Use base R versions of `purrr` `safely` functions
- `use_tidylite()`: Use base R versions of `tidyr` functions
- `use_walkers`: Use base R versions of `purrr` `walk` functions
(these support `~{}` formula functions)
## Installation

4
docs/authors.html

@ -110,6 +110,10 @@
<p><strong>Malcolm Barrett</strong>. Contributor.
</p>
</li>
<li>
<p><strong>Patrick Kennedy</strong>. Contributor. <a href='https://orcid.org/0000-0002-5525-3983' target='orcid.widget'><img src='https://members.orcid.org/sites/default/files/vector_iD_icon.svg' class='orcid' height='16'></a>
</p>
</li>
</ul>
</div>

20
docs/index.html

@ -5,11 +5,11 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code • freebase</title>
<title>A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code • freebase</title>
<!-- jquery --><script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script><!-- Font Awesome icons --><link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
<!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script><!-- pkgdown --><link href="pkgdown.css" rel="stylesheet">
<script src="jquery.sticky-kit.min.js"></script><script src="pkgdown.js"></script><meta property="og:title" content="A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code">
<script src="jquery.sticky-kit.min.js"></script><script src="pkgdown.js"></script><meta property="og:title" content="A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code">
<meta property="og:description" content="The 'tidyverse' is awesome, but can take a bit to compile on systems
where there are no pre-built binary packages. Methods are provided which use
the facilities of the 'usethis' package to snap-in base versions of useful
@ -79,7 +79,7 @@
<div id="freebase" class="section level1">
<div class="page-header"><h1 class="hasAnchor">
<a href="#freebase" class="anchor"></a>freebase</h1></div>
<p>A ‘usethis’-like Package for Base Pseudo-equivalents of ‘tidyverse’ Code</p>
<p>A ‘usethis’-esque Package for Base R Versions of ‘tidyverse’ Code</p>
<div id="description" class="section level2">
<h2 class="hasAnchor">
<a href="#description" class="anchor"></a>Description</h2>
@ -92,21 +92,21 @@
<p>The following functions are implemented:</p>
<ul>
<li>
<code>use_detect</code>: Use base-ified equivalents of “detect”-ors (these support <code>~{}</code> formula functions)</li>
<code>use_detect</code>: Use base R versions of <code>purrr</code> <code>detect</code> functions (these support <code>~{}</code> formula functions)</li>
<li>
<code>use_infix_helpers</code>: Use infix-helpers</li>
<li>
<code>use_isers</code>: Use “is_” functions</li>
<code>use_isers</code>: Use “is_” tester functions</li>
<li>
<code>use_keepers</code>: Use base-ified equivalents of keep/discard/compact (these support <code>~{}</code> formula functions)</li>
<code>use_keepers</code>: Use base R versions of <code>purrr</code> <code>keep</code> functions (these support <code>~{}</code> formula functions)</li>
<li>
<code>use_mappers</code>: Use base-ified equivalents of ‘map’-pers (these support <code>~{}</code> formula functions)</li>
<code>use_mappers</code>: Use base R versions of <code>purrr</code> <code>map</code> functions (these support <code>~{}</code> formula functions)</li>
<li>
<code>use_safely</code>: Use base-ified equivalents of “safely”-ifiers</li>
<code>use_safely</code>: Use base R versions of <code>purrr</code> <code>safely</code> functions</li>
<li>
<code><a href="reference/use_tidylite.html">use_tidylite()</a></code>: Use base R versions of ‘tidyr’ ‘gather’/‘spread’/‘unite’</li>
<code><a href="reference/use_tidylite.html">use_tidylite()</a></code>: Use base R versions of core <code>tidyr</code> functions</li>
<li>
<code>use_walkers</code>: Use base-ified equivalents of keep/discard/compact (these support <code>~{}</code> formula functions)</li>
<code>use_walkers</code>: Use base R versions of <code>purrr</code> <code>walk</code> functions (these support <code>~{}</code> formula functions)</li>
</ul>
</div>
<div id="installation" class="section level2">

6
docs/reference/freebase.html

@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code — freebase • freebase</title>
<title>A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code — freebase • freebase</title>
<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
@ -28,7 +28,7 @@
<meta property="og:title" content="A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code — freebase" />
<meta property="og:title" content="A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code — freebase" />
<meta property="og:description" content="The 'tidyverse' is awesome, but can take a bit to compile on systems
where there are no pre-built binary packages. Methods are provided which use
@ -103,7 +103,7 @@ dependencies. Use deliberately and with caution." />
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code</h1>
<h1>A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code</h1>
<small class="dont-index">Source: <a href='https://github.com/hrbrmstr/freebase/blob/master/R/freebase-package.R'><code>R/freebase-package.R</code></a></small>
<div class="hidden name"><code>freebase.Rd</code></div>
</div>

16
docs/reference/index.html

@ -116,13 +116,13 @@
<td>
<p><code><a href="freebase.html">freebase</a></code> </p>
</td>
<td><p>A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code</p></td>
<td><p>A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code</p></td>
</tr><tr>
<!-- -->
<td>
<p><code><a href="use_detect.html">use_detect()</a></code> </p>
</td>
<td><p>Use base-ified equivalents of "detect"-ors</p></td>
<td><p>Use base R versions of <code>purrr</code> <code>detect</code> functions</p></td>
</tr><tr>
<!-- -->
<td>
@ -134,37 +134,37 @@
<td>
<p><code><a href="use_isers.html">use_isers()</a></code> </p>
</td>
<td><p>Use "is_" functions</p></td>
<td><p>Use "is_" tester functions</p></td>
</tr><tr>
<!-- -->
<td>
<p><code><a href="use_keepers.html">use_keepers()</a></code> </p>
</td>
<td><p>Use base-ified equivalents of keep/discard/compact</p></td>
<td><p>Use base R versions of <code>purrr</code> <code>keep</code> functions</p></td>
</tr><tr>
<!-- -->
<td>
<p><code><a href="use_mappers.html">use_mappers()</a></code> </p>
</td>
<td><p>Use base-ified equivalents of 'map'-pers</p></td>
<td><p>Use base R versions of <code>purrr</code> <code>map</code> functions</p></td>
</tr><tr>
<!-- -->
<td>
<p><code><a href="use_safely.html">use_safely()</a></code> </p>
</td>
<td><p>Use base-ified equivalents of "safely"-ifiers</p></td>
<td><p>Use base R versions of <code>purrr</code> <code>safely</code> functions</p></td>
</tr><tr>
<!-- -->
<td>
<p><code><a href="use_tidylite.html">use_tidylite()</a></code> </p>
</td>
<td><p>Use base R versions of <code>tidyr</code> <code>gather</code>/<code>spread</code>/<code>unite</code></p></td>
<td><p>Use base R versions of <code>tidyr</code> functions</p></td>
</tr><tr>
<!-- -->
<td>
<p><code><a href="use_walkers.html">use_walkers()</a></code> </p>
</td>
<td><p>Use base-ified equivalents of <code>walk</code>/<code>walk2</code></p></td>
<td><p>Use base R versions of <code>purrr</code> <code>walk</code> functions</p></td>
</tr>
</tbody>
</table>

12
docs/reference/use_detect.html

@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Use base-ified equivalents of "detect"-ors — use_detect • freebase</title>
<title>Use base R versions of <code>purrr</code> <code>detect</code> functions — use_detect • freebase</title>
<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
@ -28,10 +28,10 @@
<meta property="og:title" content="Use base-ified equivalents of "detect"-ors use_detect" />
<meta property="og:title" content="Use base R versions of <code>purrr</code> <code>detect</code> functions — use_detect" />
<meta property="og:description" content="
Creates R/utils-detect.R with base R pseudo-equivalents for purrr detect (et al).
Creates base R versions of purrr detect (et al).
" />
<meta name="twitter:card" content="summary" />
@ -99,7 +99,7 @@ Creates R/utils-detect.R with base R pseudo-equivalents for purrr detect (et al)
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Use base-ified equivalents of "detect"-ors</h1>
<h1>Use base R versions of <code>purrr</code> <code>detect</code> functions</h1>
<small class="dont-index">Source: <a href='https://github.com/hrbrmstr/freebase/blob/master/R/use-detect.R'><code>R/use-detect.R</code></a></small>
<div class="hidden name"><code>use_detect.Rd</code></div>
</div>
@ -107,7 +107,7 @@ Creates R/utils-detect.R with base R pseudo-equivalents for purrr detect (et al)
<div class="ref-description">
<ul>
<li><p>Creates <code>R/utils-detect.R</code> with base R pseudo-equivalents for <code>purrr</code> <code>detect</code> (et al).</p></li>
<li><p>Creates base R versions of <code>purrr</code> <code>detect</code> (et al).</p></li>
</ul>
</div>
@ -119,7 +119,7 @@ Creates R/utils-detect.R with base R pseudo-equivalents for purrr detect (et al)
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>save_as</th>
<td><p>Where to save/what to name the file. Defaults to "<code>R/utils-detect.R</code>"</p></td>
<td><p>File path and name. Defaults to "<code>R/utils-detect.R</code>"</p></td>
</tr>
<tr>
<th>open</th>

6
docs/reference/use_infix_helpers.html

@ -31,7 +31,7 @@
<meta property="og:title" content="Use infix-helpers — use_infix_helpers" />
<meta property="og:description" content="
Creates R/utils-infix-helpers.R with base R %XXX% helpers
Creates base R %xyz% helpers
" />
<meta name="twitter:card" content="summary" />
@ -107,7 +107,7 @@ Creates R/utils-infix-helpers.R with base R %XXX% helpers
<div class="ref-description">
<ul>
<li><p>Creates <code>R/utils-infix-helpers.R</code> with base R <code>%XXX%</code> helpers</p></li>
<li><p>Creates base R <code>%xyz%</code> helpers</p></li>
</ul>
</div>
@ -119,7 +119,7 @@ Creates R/utils-infix-helpers.R with base R %XXX% helpers
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>save_as</th>
<td><p>Where to save/what to name the file. Defaults to "<code>R/utils-infix-helpers.R</code>"</p></td>
<td><p>File path and name. Defaults to "<code>R/utils-infix-helpers.R</code>"</p></td>
</tr>
<tr>
<th>open</th>

12
docs/reference/use_isers.html

@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Use "is_" functions — use_isers • freebase</title>
<title>Use "is_" tester functions — use_isers • freebase</title>
<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
@ -28,10 +28,10 @@
<meta property="og:title" content="Use "is_" functions use_isers" />
<meta property="og:title" content="Use "is_" tester functions use_isers" />
<meta property="og:description" content="
Creates R/utils-isers.R filled with is_... testors
Creates is_... tester functions
" />
<meta name="twitter:card" content="summary" />
@ -99,7 +99,7 @@ Creates R/utils-isers.R filled with is_... testors
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Use "is_" functions</h1>
<h1>Use "is_" tester functions</h1>
<small class="dont-index">Source: <a href='https://github.com/hrbrmstr/freebase/blob/master/R/use-isers.R'><code>R/use-isers.R</code></a></small>
<div class="hidden name"><code>use_isers.Rd</code></div>
</div>
@ -107,7 +107,7 @@ Creates R/utils-isers.R filled with is_... testors
<div class="ref-description">
<ul>
<li><p>Creates <code>R/utils-isers.R</code> filled with <code>is_...</code> testors</p></li>
<li><p>Creates <code>is_...</code> tester functions</p></li>
</ul>
</div>
@ -119,7 +119,7 @@ Creates R/utils-isers.R filled with is_... testors
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>save_as</th>
<td><p>Where to save/what to name the file. Defaults to "<code>R/utils-isers.R</code>"</p></td>
<td><p>File path and name. Defaults to "<code>R/utils-isers.R</code>"</p></td>
</tr>
<tr>
<th>open</th>

14
docs/reference/use_keepers.html

@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Use base-ified equivalents of keep/discard/compact — use_keepers • freebase</title>
<title>Use base R versions of <code>purrr</code> <code>keep</code> functions — use_keepers • freebase</title>
<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
@ -28,11 +28,10 @@
<meta property="og:title" content="Use base-ified equivalents of keep/discard/compact — use_keepers" />
<meta property="og:title" content="Use base R versions of <code>purrr</code> <code>keep</code> functions — use_keepers" />
<meta property="og:description" content="
Creates R/utils-keepers.R with base R pseudo-equivalents for purrr
keep/discard/compact
Creates base R versions of purrr keep fuctions.
" />
<meta name="twitter:card" content="summary" />
@ -100,7 +99,7 @@ keep/discard/compact
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Use base-ified equivalents of keep/discard/compact</h1>
<h1>Use base R versions of <code>purrr</code> <code>keep</code> functions</h1>
<small class="dont-index">Source: <a href='https://github.com/hrbrmstr/freebase/blob/master/R/use-keepers.R'><code>R/use-keepers.R</code></a></small>
<div class="hidden name"><code>use_keepers.Rd</code></div>
</div>
@ -108,8 +107,7 @@ keep/discard/compact
<div class="ref-description">
<ul>
<li><p>Creates <code>R/utils-keepers.R</code> with base R pseudo-equivalents for <code>purrr</code>
<code>keep</code>/<code>discard</code>/<code>compact</code></p></li>
<li><p>Creates base R versions of <code>purrr</code> <code>keep</code> fuctions.</p></li>
</ul>
</div>
@ -121,7 +119,7 @@ keep/discard/compact
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>save_as</th>
<td><p>Where to save/what to name the file. Defaults to "<code>R/utils-keepers.R</code>"</p></td>
<td><p>File path and name. Defaults to "<code>R/utils-keepers.R</code>"</p></td>
</tr>
<tr>
<th>open</th>

12
docs/reference/use_mappers.html

@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Use base-ified equivalents of 'map'-pers — use_mappers • freebase</title>
<title>Use base R versions of <code>purrr</code> <code>map</code> functions — use_mappers • freebase</title>
<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
@ -28,10 +28,10 @@
<meta property="og:title" content="Use base-ified equivalents of 'map'-pers — use_mappers" />
<meta property="og:title" content="Use base R versions of <code>purrr</code> <code>map</code> functions — use_mappers" />
<meta property="og:description" content="
Creates R/utils-mappers.R with base R pseudo-equivalents for purrr map-pers.
Creates base R versions of purrr map functions.
" />
<meta name="twitter:card" content="summary" />
@ -99,7 +99,7 @@ Creates R/utils-mappers.R with base R pseudo-equivalents for purrr map-pers.
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Use base-ified equivalents of 'map'-pers</h1>
<h1>Use base R versions of <code>purrr</code> <code>map</code> functions</h1>
<small class="dont-index">Source: <a href='https://github.com/hrbrmstr/freebase/blob/master/R/use-mappers.R'><code>R/use-mappers.R</code></a></small>
<div class="hidden name"><code>use_mappers.Rd</code></div>
</div>
@ -107,7 +107,7 @@ Creates R/utils-mappers.R with base R pseudo-equivalents for purrr map-pers.
<div class="ref-description">
<ul>
<li><p>Creates <code>R/utils-mappers.R</code> with base R pseudo-equivalents for <code>purrr</code> <code>map</code>-pers.</p></li>
<li><p>Creates base R versions of <code>purrr</code> <code>map</code> functions.</p></li>
</ul>
</div>
@ -119,7 +119,7 @@ Creates R/utils-mappers.R with base R pseudo-equivalents for purrr map-pers.
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>save_as</th>
<td><p>Where to save/what to name the file. Defaults to "<code>R/utils-mappers.R</code>"</p></td>
<td><p>File path and name. Defaults to "<code>R/utils-mappers.R</code>"</p></td>
</tr>
<tr>
<th>open</th>

12
docs/reference/use_safely.html

@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Use base-ified equivalents of "safely"-ifiers — use_safely • freebase</title>
<title>Use base R versions of <code>purrr</code> <code>safely</code> functions — use_safely • freebase</title>
<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
@ -28,10 +28,10 @@
<meta property="og:title" content="Use base-ified equivalents of "safely"-ifiers use_safely" />
<meta property="og:title" content="Use base R versions of <code>purrr</code> <code>safely</code> functions — use_safely" />
<meta property="og:description" content="
Creates R/utils-safely.R with base R pseudo-equivalents for purrr safely (et al).
Creates base R versions of purrr safely (et al).
" />
<meta name="twitter:card" content="summary" />
@ -99,7 +99,7 @@ Creates R/utils-safely.R with base R pseudo-equivalents for purrr safely (et al)
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Use base-ified equivalents of "safely"-ifiers</h1>
<h1>Use base R versions of <code>purrr</code> <code>safely</code> functions</h1>
<small class="dont-index">Source: <a href='https://github.com/hrbrmstr/freebase/blob/master/R/use-safely.R'><code>R/use-safely.R</code></a></small>
<div class="hidden name"><code>use_safely.Rd</code></div>
</div>
@ -107,7 +107,7 @@ Creates R/utils-safely.R with base R pseudo-equivalents for purrr safely (et al)
<div class="ref-description">
<ul>
<li><p>Creates <code>R/utils-safely.R</code> with base R pseudo-equivalents for <code>purrr</code> <code>safely</code> (et al).</p></li>
<li><p>Creates base R versions of <code>purrr</code> <code>safely</code> (et al).</p></li>
</ul>
</div>
@ -119,7 +119,7 @@ Creates R/utils-safely.R with base R pseudo-equivalents for purrr safely (et al)
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>save_as</th>
<td><p>Where to save/what to name the file. Defaults to "<code>R/utils-safely.R</code>"</p></td>
<td><p>File path and name. Defaults to "<code>R/utils-safely.R</code>"</p></td>
</tr>
<tr>
<th>open</th>

12
docs/reference/use_tidylite.html

@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Use base R versions of <code>tidyr</code> <code>gather</code>/<code>spread</code>/<code>unite</code> — use_tidylite • freebase</title>
<title>Use base R versions of <code>tidyr</code> functions — use_tidylite • freebase</title>
<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
@ -28,10 +28,10 @@
<meta property="og:title" content="Use base R versions of <code>tidyr</code> <code>gather</code>/<code>spread</code>/<code>unite</code> — use_tidylite" />
<meta property="og:title" content="Use base R versions of <code>tidyr</code> functions — use_tidylite" />
<meta property="og:description" content="
Creates R/utils-tidylite.R containing gatherlite(), spreadlite() and unitelite()
Creates base R versions of tidyr functions
" />
<meta name="twitter:card" content="summary" />
@ -99,7 +99,7 @@ Creates R/utils-tidylite.R containing gatherlite(), spreadlite() and unitelite()
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Use base R versions of <code>tidyr</code> <code>gather</code>/<code>spread</code>/<code>unite</code></h1>
<h1>Use base R versions of <code>tidyr</code> functions</h1>
<small class="dont-index">Source: <a href='https://github.com/hrbrmstr/freebase/blob/master/R/use-tidylite.R'><code>R/use-tidylite.R</code></a></small>
<div class="hidden name"><code>use_tidylite.Rd</code></div>
</div>
@ -107,7 +107,7 @@ Creates R/utils-tidylite.R containing gatherlite(), spreadlite() and unitelite()
<div class="ref-description">
<ul>
<li><p>Creates <code>R/utils-tidylite.R</code> containing <code>gatherlite()</code>, <code>spreadlite()</code> and <code>unitelite()</code></p></li>
<li><p>Creates base R versions of <code>tidyr</code> functions</p></li>
</ul>
</div>
@ -119,7 +119,7 @@ Creates R/utils-tidylite.R containing gatherlite(), spreadlite() and unitelite()
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>save_as</th>
<td><p>Where to save/what to name the file. Defaults to "<code>R/utils-tidylite.R</code>"</p></td>
<td><p>File path and name. Defaults to "<code>R/utils-tidylite.R</code>"</p></td>
</tr>
<tr>
<th>open</th>

14
docs/reference/use_walkers.html

@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Use base-ified equivalents of <code>walk</code>/<code>walk2</code> — use_walkers • freebase</title>
<title>Use base R versions of <code>purrr</code> <code>walk</code> functions — use_walkers • freebase</title>
<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
@ -28,11 +28,10 @@
<meta property="og:title" content="Use base-ified equivalents of <code>walk</code>/<code>walk2</code> — use_walkers" />
<meta property="og:title" content="Use base R versions of <code>purrr</code> <code>walk</code> functions — use_walkers" />
<meta property="og:description" content="
Creates R/utils-walkers.R with base R pseudo-equivalents for purrr
walk/walk2
Creates base R versions of purrr walk functions
" />
<meta name="twitter:card" content="summary" />
@ -100,7 +99,7 @@ walk/walk2
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Use base-ified equivalents of <code>walk</code>/<code>walk2</code></h1>
<h1>Use base R versions of <code>purrr</code> <code>walk</code> functions</h1>
<small class="dont-index">Source: <a href='https://github.com/hrbrmstr/freebase/blob/master/R/use-walkers.R'><code>R/use-walkers.R</code></a></small>
<div class="hidden name"><code>use_walkers.Rd</code></div>
</div>
@ -108,8 +107,7 @@ walk/walk2
<div class="ref-description">
<ul>
<li><p>Creates <code>R/utils-walkers.R</code> with base R pseudo-equivalents for <code>purrr</code>
<code>walk</code>/<code>walk2</code></p></li>
<li><p>Creates base R versions of <code>purrr</code> <code>walk</code> functions</p></li>
</ul>
</div>
@ -121,7 +119,7 @@ walk/walk2
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>save_as</th>
<td><p>Where to save/what to name the file. Defaults to "<code>R/utils-walkers.R</code>"</p></td>
<td><p>File path and name. Defaults to "<code>R/utils-walkers.R</code>"</p></td>
</tr>
<tr>
<th>open</th>

1
inst/templates/keepers.R

@ -14,4 +14,3 @@ discard <- function(.x, .p, ...) {
compact <- function(.x, .p=identity) {
discard(.x, function(x) is_empty(.p(x)))
}

2
man/freebase.Rd

@ -4,7 +4,7 @@
\name{freebase}
\alias{freebase}
\alias{freebase-package}
\title{A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code}
\title{A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code}
\description{
The 'tidyverse' is awesome, but can take a bit to compile on systems
where there are no pre-built binary packages. Methods are provided which use

6
man/use_detect.Rd

@ -2,18 +2,18 @@
% Please edit documentation in R/use-detect.R
\name{use_detect}
\alias{use_detect}
\title{Use base-ified equivalents of "detect"-ors}
\title{Use base R versions of \code{purrr} \code{detect} functions}
\usage{
use_detect(save_as = "R/utils-detect.R", open = TRUE)
}
\arguments{
\item{save_as}{Where to save/what to name the file. Defaults to "\code{R/utils-detect.R}"}
\item{save_as}{File path and name. Defaults to "\code{R/utils-detect.R}"}
\item{open}{if \code{TRUE}, open the resultant file}
}
\description{
\itemize{
\item Creates \code{R/utils-detect.R} with base R pseudo-equivalents for \code{purrr} \code{detect} (et al).
\item Creates base R versions of \code{purrr} \code{detect} (et al).
}
}
\details{

4
man/use_infix_helpers.Rd

@ -7,12 +7,12 @@
use_infix_helpers(save_as = "R/utils-infix-helpers.R", open = TRUE)
}
\arguments{
\item{save_as}{Where to save/what to name the file. Defaults to "\code{R/utils-infix-helpers.R}"}
\item{save_as}{File path and name. Defaults to "\code{R/utils-infix-helpers.R}"}
\item{open}{if \code{TRUE}, open the resultant file}
}
\description{
\itemize{
\item Creates \code{R/utils-infix-helpers.R} with base R \code{\%XXX\%} helpers
\item Creates base R \code{\%xyz\%} helpers
}
}

6
man/use_isers.Rd

@ -2,17 +2,17 @@
% Please edit documentation in R/use-isers.R
\name{use_isers}
\alias{use_isers}
\title{Use "is_" functions}
\title{Use "is_" tester functions}
\usage{
use_isers(save_as = "R/utils-isers.R", open = TRUE)
}
\arguments{
\item{save_as}{Where to save/what to name the file. Defaults to "\code{R/utils-isers.R}"}
\item{save_as}{File path and name. Defaults to "\code{R/utils-isers.R}"}
\item{open}{if \code{TRUE}, open the resultant file}
}
\description{
\itemize{
\item Creates \code{R/utils-isers.R} filled with \code{is_...} testors
\item Creates \code{is_...} tester functions
}
}

7
man/use_keepers.Rd

@ -2,19 +2,18 @@
% Please edit documentation in R/use-keepers.R
\name{use_keepers}
\alias{use_keepers}
\title{Use base-ified equivalents of keep/discard/compact}
\title{Use base R versions of \code{purrr} \code{keep} functions}
\usage{
use_keepers(save_as = "R/utils-keepers.R", open = TRUE)
}
\arguments{
\item{save_as}{Where to save/what to name the file. Defaults to "\code{R/utils-keepers.R}"}
\item{save_as}{File path and name. Defaults to "\code{R/utils-keepers.R}"}
\item{open}{if \code{TRUE}, open the resultant file}
}
\description{
\itemize{
\item Creates \code{R/utils-keepers.R} with base R pseudo-equivalents for \code{purrr}
\code{keep}/\code{discard}/\code{compact}
\item Creates base R versions of \code{purrr} \code{keep} fuctions.
}
}
\details{

6
man/use_mappers.Rd

@ -2,18 +2,18 @@
% Please edit documentation in R/use-mappers.R
\name{use_mappers}
\alias{use_mappers}
\title{Use base-ified equivalents of 'map'-pers}
\title{Use base R versions of \code{purrr} \code{map} functions}
\usage{
use_mappers(save_as = "R/utils-mappers.R", open = TRUE)
}
\arguments{
\item{save_as}{Where to save/what to name the file. Defaults to "\code{R/utils-mappers.R}"}
\item{save_as}{File path and name. Defaults to "\code{R/utils-mappers.R}"}
\item{open}{if \code{TRUE}, open the resultant file}
}
\description{
\itemize{
\item Creates \code{R/utils-mappers.R} with base R pseudo-equivalents for \code{purrr} \code{map}-pers.
\item Creates base R versions of \code{purrr} \code{map} functions.
}
}
\details{

6
man/use_safely.Rd

@ -2,17 +2,17 @@
% Please edit documentation in R/use-safely.R
\name{use_safely}
\alias{use_safely}
\title{Use base-ified equivalents of "safely"-ifiers}
\title{Use base R versions of \code{purrr} \code{safely} functions}
\usage{
use_safely(save_as = "R/utils-safely.R", open = TRUE)
}
\arguments{
\item{save_as}{Where to save/what to name the file. Defaults to "\code{R/utils-safely.R}"}
\item{save_as}{File path and name. Defaults to "\code{R/utils-safely.R}"}
\item{open}{if \code{TRUE}, open the resultant file}
}
\description{
\itemize{
\item Creates \code{R/utils-safely.R} with base R pseudo-equivalents for \code{purrr} \code{safely} (et al).
\item Creates base R versions of \code{purrr} \code{safely} (et al).
}
}

6
man/use_tidylite.Rd

@ -2,17 +2,17 @@
% Please edit documentation in R/use-tidylite.R
\name{use_tidylite}
\alias{use_tidylite}
\title{Use base R versions of \code{tidyr} \code{gather}/\code{spread}/\code{unite}}
\title{Use base R versions of \code{tidyr} functions}
\usage{
use_tidylite(save_as = "R/utils-tidylite.R", open = TRUE)
}
\arguments{
\item{save_as}{Where to save/what to name the file. Defaults to "\code{R/utils-tidylite.R}"}
\item{save_as}{File path and name. Defaults to "\code{R/utils-tidylite.R}"}
\item{open}{if \code{TRUE}, open the resultant file}
}
\description{
\itemize{
\item Creates \code{R/utils-tidylite.R} containing \code{gatherlite()}, \code{spreadlite()} and \code{unitelite()}
\item Creates base R versions of \code{tidyr} functions
}
}

7
man/use_walkers.Rd

@ -2,19 +2,18 @@
% Please edit documentation in R/use-walkers.R
\name{use_walkers}
\alias{use_walkers}
\title{Use base-ified equivalents of \code{walk}/\code{walk2}}
\title{Use base R versions of \code{purrr} \code{walk} functions}
\usage{
use_walkers(save_as = "R/utils-walkers.R", open = TRUE)
}
\arguments{
\item{save_as}{Where to save/what to name the file. Defaults to "\code{R/utils-walkers.R}"}
\item{save_as}{File path and name. Defaults to "\code{R/utils-walkers.R}"}
\item{open}{if \code{TRUE}, open the resultant file}
}
\description{
\itemize{
\item Creates \code{R/utils-walkers.R} with base R pseudo-equivalents for \code{purrr}
\code{walk}/\code{walk2}
\item Creates base R versions of \code{purrr} \code{walk} functions
}
}
\details{

Loading…
Cancel
Save