From 683de380b03c6b645ce1d7fee6ef8c04af824ff7 Mon Sep 17 00:00:00 2001 From: Patrick Kennedy Date: Wed, 30 May 2018 15:09:03 -0700 Subject: [PATCH] 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" --- DESCRIPTION | 6 ++++-- R/freebase-package.R | 2 +- R/use-detect.R | 10 +++++----- R/use-infix-helpers.R | 8 ++++---- R/use-isers.R | 10 +++++----- R/use-keepers.R | 11 +++++------ R/use-mappers.R | 10 +++++----- R/use-safely.R | 10 +++++----- R/use-tidylite.R | 10 +++++----- R/use-walkers.R | 11 +++++------ R/utils.R | 2 +- README.Rmd | 18 +++++++++--------- README.md | 19 +++++++++---------- docs/authors.html | 4 ++++ docs/index.html | 20 ++++++++++---------- docs/reference/freebase.html | 6 +++--- docs/reference/index.html | 16 ++++++++-------- docs/reference/use_detect.html | 12 ++++++------ docs/reference/use_infix_helpers.html | 6 +++--- docs/reference/use_isers.html | 12 ++++++------ docs/reference/use_keepers.html | 14 ++++++-------- docs/reference/use_mappers.html | 12 ++++++------ docs/reference/use_safely.html | 12 ++++++------ docs/reference/use_tidylite.html | 12 ++++++------ docs/reference/use_walkers.html | 14 ++++++-------- inst/templates/infix-helpers.R | 2 +- inst/templates/is-ers.R | 2 +- inst/templates/keepers.R | 1 - man/freebase.Rd | 2 +- man/use_detect.Rd | 6 +++--- man/use_infix_helpers.Rd | 4 ++-- man/use_isers.Rd | 6 +++--- man/use_keepers.Rd | 7 +++---- man/use_mappers.Rd | 6 +++--- man/use_safely.Rd | 6 +++--- man/use_tidylite.Rd | 6 +++--- man/use_walkers.Rd | 7 +++---- 37 files changed, 159 insertions(+), 163 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 064903c..5c77995 100644 --- a/DESCRIPTION +++ b/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 Description: The 'tidyverse' is awesome, but can take a bit to compile on systems diff --git a/R/freebase-package.R b/R/freebase-package.R index 5f63854..d6697d0 100644 --- a/R/freebase-package.R +++ b/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 diff --git a/R/use-detect.R b/R/use-detect.R index beaef64..7e02bf3 100644 --- a/R/use-detect.R +++ b/R/use-detect.R @@ -1,17 +1,17 @@ -#' 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) { check_is_package("use_detect()") - use_template("detect.R", save_as = save_as , open = open, package = "freebase") + use_template("detect.R", save_as = save_as, open = open, package = "freebase") -} \ No newline at end of file +} diff --git a/R/use-infix-helpers.R b/R/use-infix-helpers.R index a0ca6bc..278727c 100644 --- a/R/use-infix-helpers.R +++ b/R/use-infix-helpers.R @@ -1,15 +1,15 @@ #' 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) { check_is_package("use_infix_helpers()") - use_template("infix-helpers.R", save_as = save_as , open = open, package = "freebase") + use_template("infix-helpers.R", save_as = save_as, open = open, package = "freebase") -} \ No newline at end of file +} diff --git a/R/use-isers.R b/R/use-isers.R index 48a3b19..4e5a4d4 100644 --- a/R/use-isers.R +++ b/R/use-isers.R @@ -1,15 +1,15 @@ -#' 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) { check_is_package("use_isers()") - use_template("is-ers.R", save_as = save_as , open = open, package = "freebase") + use_template("is-ers.R", save_as = save_as, open = open, package = "freebase") -} \ No newline at end of file +} diff --git a/R/use-keepers.R b/R/use-keepers.R index 0c21e23..8bf5fc7 100644 --- a/R/use-keepers.R +++ b/R/use-keepers.R @@ -1,18 +1,17 @@ -#' 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) { check_is_package("use_keepers()") - use_template("keepers.R", save_as = save_as , open = open, package = "freebase") + use_template("keepers.R", save_as = save_as, open = open, package = "freebase") -} \ No newline at end of file +} diff --git a/R/use-mappers.R b/R/use-mappers.R index 7376c35..c3f9fe4 100644 --- a/R/use-mappers.R +++ b/R/use-mappers.R @@ -1,17 +1,17 @@ -#' 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) { check_is_package("use_mappers()") - use_template("mappers.R", save_as = save_as , open = open, package = "freebase") + use_template("mappers.R", save_as = save_as, open = open, package = "freebase") -} \ No newline at end of file +} diff --git a/R/use-safely.R b/R/use-safely.R index 04bd022..35938a0 100644 --- a/R/use-safely.R +++ b/R/use-safely.R @@ -1,15 +1,15 @@ -#' 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) { check_is_package("use_safely()") - use_template("safely.R", save_as = save_as , open = open, package = "freebase") + use_template("safely.R", save_as = save_as, open = open, package = "freebase") -} \ No newline at end of file +} diff --git a/R/use-tidylite.R b/R/use-tidylite.R index 838bb55..baad9f5 100644 --- a/R/use-tidylite.R +++ b/R/use-tidylite.R @@ -1,15 +1,15 @@ -#' 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) { check_is_package("use_tidylite()") - use_template("tidylite.R", save_as = save_as , open = open, package = "freebase") + use_template("tidylite.R", save_as = save_as, open = open, package = "freebase") -} \ No newline at end of file +} diff --git a/R/use-walkers.R b/R/use-walkers.R index a8c7db5..570a162 100644 --- a/R/use-walkers.R +++ b/R/use-walkers.R @@ -1,18 +1,17 @@ -#' 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) { check_is_package("use_walkers()") - use_template("walkers.R", save_as = save_as , open = open, package = "freebase") + use_template("walkers.R", save_as = save_as, open = open, package = "freebase") -} \ No newline at end of file +} diff --git a/R/utils.R b/R/utils.R index 461baf4..8415b01 100644 --- a/R/utils.R +++ b/R/utils.R @@ -42,4 +42,4 @@ project_name <- function (base_path = usethis::proj_get()) { else { basename(normalizePath(base_path, mustWork = FALSE)) } -} \ No newline at end of file +} diff --git a/README.Rmd b/README.Rmd index a1893ee..bfd3b9d 100644 --- a/README.Rmd +++ b/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_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_detect`: Use base R versions of `purrr` `detect` functions (these support `~{}` formula functions) +- `use_infix_helpers`: Use infix-helpers +- `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 diff --git a/README.md b/README.md index 842d5fd..0f23b03 100644 --- a/README.md +++ b/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 diff --git a/docs/authors.html b/docs/authors.html index d84723f..70de7f4 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -110,6 +110,10 @@

Malcolm Barrett. Contributor.

+
  • +

    Patrick Kennedy. Contributor. +

    +
    • diff --git a/docs/index.html b/docs/index.html index 64f8170..8e68296 100644 --- a/docs/index.html +++ b/docs/index.html @@ -5,11 +5,11 @@ -A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code • freebase +A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code • freebase - +

    freebase

    -

    A ‘usethis’-like Package for Base Pseudo-equivalents of ‘tidyverse’ Code

    +

    A ‘usethis’-esque Package for Base R Versions of ‘tidyverse’ Code

    Description

    @@ -92,21 +92,21 @@

    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_isers: Use “is_” tester functions
    • -use_keepers: Use base-ified equivalents of keep/discard/compact (these support ~{} formula 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 support ~{} formula functions)
      • +use_mappers: Use base R versions of purrr map functions (these support ~{} formula functions)
    • -use_safely: Use base-ified equivalents of “safely”-ifiers
      • +use_safely: Use base R versions of purrr safely functions
    • -use_tidylite(): Use base R versions of ‘tidyr’ ‘gather’/‘spread’/‘unite’
      • +use_tidylite(): Use base R versions of core tidyr functions
    • -use_walkers: Use base-ified equivalents of keep/discard/compact (these support ~{} formula functions)
      • +use_walkers: Use base R versions of purrr walk functions (these support ~{} formula functions)
    diff --git a/docs/reference/freebase.html b/docs/reference/freebase.html index 35543e1..6e4e38a 100644 --- a/docs/reference/freebase.html +++ b/docs/reference/freebase.html @@ -6,7 +6,7 @@ -A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code — freebase • freebase +A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code — freebase • freebase @@ -28,7 +28,7 @@ - +
    -

    A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code

    +

    A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code

    Source: R/freebase-package.R
    diff --git a/docs/reference/index.html b/docs/reference/index.html index 27206f5..b772921 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -116,13 +116,13 @@

    freebase

    -

    A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code

    +

    A 'usethis'-esque Package for Base R Versions of 'tidyverse' Code

    use_detect()

    -

    Use base-ified equivalents of "detect"-ors

    +

    Use base R versions of purrr detect functions

    @@ -134,37 +134,37 @@

    use_isers()

    -

    Use "is_" functions

    +

    Use "is_" tester functions

    use_keepers()

    -

    Use base-ified equivalents of keep/discard/compact

    +

    Use base R versions of purrr keep functions

    use_mappers()

    -

    Use base-ified equivalents of 'map'-pers

    +

    Use base R versions of purrr map functions

    use_safely()

    -

    Use base-ified equivalents of "safely"-ifiers

    +

    Use base R versions of purrr safely functions

    use_tidylite()

    -

    Use base R versions of tidyr gather/spread/unite

    +

    Use base R versions of tidyr functions

    use_walkers()

    -

    Use base-ified equivalents of walk/walk2

    +

    Use base R versions of purrr walk functions

    diff --git a/docs/reference/use_detect.html b/docs/reference/use_detect.html index 49bef61..385d73b 100644 --- a/docs/reference/use_detect.html +++ b/docs/reference/use_detect.html @@ -6,7 +6,7 @@ -Use base-ified equivalents of "detect"-ors — use_detect • freebase +Use base R versions of <code>purrr</code> <code>detect</code> functions — use_detect • freebase @@ -28,10 +28,10 @@ - + @@ -99,7 +99,7 @@ Creates R/utils-detect.R with base R pseudo-equivalents for purrr detect (et al)
    -

    Use base-ified equivalents of "detect"-ors

    +

    Use base R versions of purrr detect functions

    Source: R/use-detect.R
    @@ -107,7 +107,7 @@ Creates R/utils-detect.R with base R pseudo-equivalents for purrr detect (et al)
      -

    • Creates R/utils-detect.R with base R pseudo-equivalents for purrr detect (et al).

      • +

    • Creates base R versions of purrr detect (et al).

    @@ -119,7 +119,7 @@ Creates R/utils-detect.R with base R pseudo-equivalents for purrr detect (et al) save_as -

    Where to save/what to name the file. Defaults to "R/utils-detect.R"

    +

    File path and name. Defaults to "R/utils-detect.R"

    open diff --git a/docs/reference/use_infix_helpers.html b/docs/reference/use_infix_helpers.html index 357d0e6..2c45a2a 100644 --- a/docs/reference/use_infix_helpers.html +++ b/docs/reference/use_infix_helpers.html @@ -31,7 +31,7 @@ @@ -107,7 +107,7 @@ Creates R/utils-infix-helpers.R with base R %XXX% helpers
      -

    • Creates R/utils-infix-helpers.R with base R %XXX% helpers

      • +

    • Creates base R %xyz% helpers

    @@ -119,7 +119,7 @@ Creates R/utils-infix-helpers.R with base R %XXX% helpers save_as -

    Where to save/what to name the file. Defaults to "R/utils-infix-helpers.R"

    +

    File path and name. Defaults to "R/utils-infix-helpers.R"

    open diff --git a/docs/reference/use_isers.html b/docs/reference/use_isers.html index 2cc7463..da3420f 100644 --- a/docs/reference/use_isers.html +++ b/docs/reference/use_isers.html @@ -6,7 +6,7 @@ -Use "is_" functions — use_isers • freebase +Use "is_" tester functions — use_isers • freebase @@ -28,10 +28,10 @@ - + @@ -99,7 +99,7 @@ Creates R/utils-isers.R filled with is_... testors
    -

    Use "is_" functions

    +

    Use "is_" tester functions

    Source: R/use-isers.R
    @@ -107,7 +107,7 @@ Creates R/utils-isers.R filled with is_... testors
      -

    • Creates R/utils-isers.R filled with is_... testors

      • +

    • Creates is_... tester functions

    @@ -119,7 +119,7 @@ Creates R/utils-isers.R filled with is_... testors save_as -

    Where to save/what to name the file. Defaults to "R/utils-isers.R"

    +

    File path and name. Defaults to "R/utils-isers.R"

    open diff --git a/docs/reference/use_keepers.html b/docs/reference/use_keepers.html index 473b8a4..589c834 100644 --- a/docs/reference/use_keepers.html +++ b/docs/reference/use_keepers.html @@ -6,7 +6,7 @@ -Use base-ified equivalents of keep/discard/compact — use_keepers • freebase +Use base R versions of <code>purrr</code> <code>keep</code> functions — use_keepers • freebase @@ -28,11 +28,10 @@ - + @@ -100,7 +99,7 @@ keep/discard/compact
    -

    Use base-ified equivalents of keep/discard/compact

    +

    Use base R versions of purrr keep functions

    Source: R/use-keepers.R
    @@ -108,8 +107,7 @@ keep/discard/compact
      -

    • Creates R/utils-keepers.R with base R pseudo-equivalents for purrr -keep/discard/compact

      • +

    • Creates base R versions of purrr keep fuctions.

    @@ -121,7 +119,7 @@ keep/discard/compact save_as -

    Where to save/what to name the file. Defaults to "R/utils-keepers.R"

    +

    File path and name. Defaults to "R/utils-keepers.R"

    open diff --git a/docs/reference/use_mappers.html b/docs/reference/use_mappers.html index 00a326f..0ea6c07 100644 --- a/docs/reference/use_mappers.html +++ b/docs/reference/use_mappers.html @@ -6,7 +6,7 @@ -Use base-ified equivalents of 'map'-pers — use_mappers • freebase +Use base R versions of <code>purrr</code> <code>map</code> functions — use_mappers • freebase @@ -28,10 +28,10 @@ - + @@ -99,7 +99,7 @@ Creates R/utils-mappers.R with base R pseudo-equivalents for purrr map-pers.
    -

    Use base-ified equivalents of 'map'-pers

    +

    Use base R versions of purrr map functions

    Source: R/use-mappers.R
    @@ -107,7 +107,7 @@ Creates R/utils-mappers.R with base R pseudo-equivalents for purrr map-pers.
      -

    • Creates R/utils-mappers.R with base R pseudo-equivalents for purrr map-pers.

      • +

    • Creates base R versions of purrr map functions.

    @@ -119,7 +119,7 @@ Creates R/utils-mappers.R with base R pseudo-equivalents for purrr map-pers. save_as -

    Where to save/what to name the file. Defaults to "R/utils-mappers.R"

    +

    File path and name. Defaults to "R/utils-mappers.R"

    open diff --git a/docs/reference/use_safely.html b/docs/reference/use_safely.html index 7a88262..bfbb24f 100644 --- a/docs/reference/use_safely.html +++ b/docs/reference/use_safely.html @@ -6,7 +6,7 @@ -Use base-ified equivalents of "safely"-ifiers — use_safely • freebase +Use base R versions of <code>purrr</code> <code>safely</code> functions — use_safely • freebase @@ -28,10 +28,10 @@ - + @@ -99,7 +99,7 @@ Creates R/utils-safely.R with base R pseudo-equivalents for purrr safely (et al)
    -

    Use base-ified equivalents of "safely"-ifiers

    +

    Use base R versions of purrr safely functions

    Source: R/use-safely.R
    @@ -107,7 +107,7 @@ Creates R/utils-safely.R with base R pseudo-equivalents for purrr safely (et al)
      -

    • Creates R/utils-safely.R with base R pseudo-equivalents for purrr safely (et al).

      • +

    • Creates base R versions of purrr safely (et al).

    @@ -119,7 +119,7 @@ Creates R/utils-safely.R with base R pseudo-equivalents for purrr safely (et al) save_as -

    Where to save/what to name the file. Defaults to "R/utils-safely.R"

    +

    File path and name. Defaults to "R/utils-safely.R"

    open diff --git a/docs/reference/use_tidylite.html b/docs/reference/use_tidylite.html index fed2637..d1929ce 100644 --- a/docs/reference/use_tidylite.html +++ b/docs/reference/use_tidylite.html @@ -6,7 +6,7 @@ -Use base R versions of <code>tidyr</code> <code>gather</code>/<code>spread</code>/<code>unite</code> — use_tidylite • freebase +Use base R versions of <code>tidyr</code> functions — use_tidylite • freebase @@ -28,10 +28,10 @@ - + @@ -99,7 +99,7 @@ Creates R/utils-tidylite.R containing gatherlite(), spreadlite() and unitelite()
    -

    Use base R versions of tidyr gather/spread/unite

    +

    Use base R versions of tidyr functions

    Source: R/use-tidylite.R
    @@ -107,7 +107,7 @@ Creates R/utils-tidylite.R containing gatherlite(), spreadlite() and unitelite()
      -

    • Creates R/utils-tidylite.R containing gatherlite(), spreadlite() and unitelite()

      • +

    • Creates base R versions of tidyr functions

    @@ -119,7 +119,7 @@ Creates R/utils-tidylite.R containing gatherlite(), spreadlite() and unitelite() save_as -

    Where to save/what to name the file. Defaults to "R/utils-tidylite.R"

    +

    File path and name. Defaults to "R/utils-tidylite.R"

    open diff --git a/docs/reference/use_walkers.html b/docs/reference/use_walkers.html index c1dafab..9f93a1b 100644 --- a/docs/reference/use_walkers.html +++ b/docs/reference/use_walkers.html @@ -6,7 +6,7 @@ -Use base-ified equivalents of <code>walk</code>/<code>walk2</code> — use_walkers • freebase +Use base R versions of <code>purrr</code> <code>walk</code> functions — use_walkers • freebase @@ -28,11 +28,10 @@ - + @@ -100,7 +99,7 @@ walk/walk2
    -

    Use base-ified equivalents of walk/walk2

    +

    Use base R versions of purrr walk functions

    Source: R/use-walkers.R
    @@ -108,8 +107,7 @@ walk/walk2
      -

    • Creates R/utils-walkers.R with base R pseudo-equivalents for purrr -walk/walk2

      • +

    • Creates base R versions of purrr walk functions

    @@ -121,7 +119,7 @@ walk/walk2 save_as -

    Where to save/what to name the file. Defaults to "R/utils-walkers.R"

    +

    File path and name. Defaults to "R/utils-walkers.R"

    open diff --git a/inst/templates/infix-helpers.R b/inst/templates/infix-helpers.R index a447328..11e792d 100644 --- a/inst/templates/infix-helpers.R +++ b/inst/templates/infix-helpers.R @@ -1,4 +1,4 @@ `%l0%` <- function(x, y) if (length(x) == 0) y else x `%||%` <- function(x, y) if (is.null(x)) y else x `%@%` <- function(x, name) attr(x, name, exact = TRUE) -`%nin%` <- function(x, table) match(x, table, nomatch = 0) == 0 \ No newline at end of file +`%nin%` <- function(x, table) match(x, table, nomatch = 0) == 0 diff --git a/inst/templates/is-ers.R b/inst/templates/is-ers.R index eb4b385..7dd1881 100644 --- a/inst/templates/is-ers.R +++ b/inst/templates/is-ers.R @@ -3,5 +3,5 @@ is_odd <- function(x) x %% 2 != 0 is_empty <- function(x) length(x) == 0 -is_true <- function (x) identical(x, TRUE) +is_true <- function(x) identical(x, TRUE) is_false <- function(x) identical(x, FALSE) diff --git a/inst/templates/keepers.R b/inst/templates/keepers.R index 022bee3..f522faf 100644 --- a/inst/templates/keepers.R +++ b/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))) } - diff --git a/man/freebase.Rd b/man/freebase.Rd index 9402389..9a9c81a 100644 --- a/man/freebase.Rd +++ b/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 diff --git a/man/use_detect.Rd b/man/use_detect.Rd index b0c633c..97e816e 100644 --- a/man/use_detect.Rd +++ b/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{ diff --git a/man/use_infix_helpers.Rd b/man/use_infix_helpers.Rd index 7ab65b5..e777ae2 100644 --- a/man/use_infix_helpers.Rd +++ b/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 } } diff --git a/man/use_isers.Rd b/man/use_isers.Rd index 8864171..baba1e1 100644 --- a/man/use_isers.Rd +++ b/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 } } diff --git a/man/use_keepers.Rd b/man/use_keepers.Rd index 3b69cf1..07bf734 100644 --- a/man/use_keepers.Rd +++ b/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{ diff --git a/man/use_mappers.Rd b/man/use_mappers.Rd index 40cdb39..41f2e34 100644 --- a/man/use_mappers.Rd +++ b/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{ diff --git a/man/use_safely.Rd b/man/use_safely.Rd index 5ed6674..4bb7ff8 100644 --- a/man/use_safely.Rd +++ b/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). } } diff --git a/man/use_tidylite.Rd b/man/use_tidylite.Rd index 8895326..a397c95 100644 --- a/man/use_tidylite.Rd +++ b/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 } } diff --git a/man/use_walkers.Rd b/man/use_walkers.Rd index bd8bb3c..489fd40 100644 --- a/man/use_walkers.Rd +++ b/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{