Browse Source

Fix typos in documentation

master
Patrick Kennedy 6 years ago
parent
commit
5acb35a34d
  1. 2
      DESCRIPTION
  2. 2
      R/freebase-package.R
  3. 2
      R/use-isers.R
  4. 2
      R/use-walkers.R
  5. 5
      README.Rmd
  6. 8
      README.md
  7. 6
      docs/index.html
  8. 2
      docs/pkgdown.yml
  9. 4
      docs/reference/freebase.html
  10. 4
      docs/reference/index.html
  11. 2
      docs/reference/use_isers.html
  12. 10
      docs/reference/use_tidylite.html
  13. 6
      docs/reference/use_walkers.html
  14. 2
      inst/templates/walkers.R
  15. 2
      man/freebase.Rd
  16. 2
      man/use_isers.Rd
  17. 4
      man/use_tidylite.Rd
  18. 2
      man/use_walkers.Rd

2
DESCRIPTION

@ -11,7 +11,7 @@ Authors@R: c(
person("Malcolm", "Barrett", email = "malcolmbarrett@gmail.com", role = c("ctb"))
)
Maintainer: Bob Rudis <bob@rud.is>
Description: The 'tidyverse' is awesome, but can take a bit compile on systems
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
the facilities of the 'usethis' package to snap-in base versions of useful
'tidyverse' functions that are mostly equivalent (some are more complete

2
R/freebase-package.R

@ -1,6 +1,6 @@
#' A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code
#'
#' The 'tidyverse' is awesome, but can take a bit compile on systems
#' 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
#' 'tidyverse' functions that are mostly equivalent (some are more complete

2
R/use-isers.R

@ -3,7 +3,7 @@
#' * Creates `R/utils-isers.R` filled with `is_...` testors
#'
#' @md
#' @param save_as Where to save/what to name the file. Defaults to "`R/utils-detect.R`"
#' @param save_as Where to save/what to name the file. 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) {

2
R/use-walkers.R

@ -1,4 +1,4 @@
#' Use base-ified equivalents of keep/discard/compact
#' Use base-ified equivalents of `walk`/`walk2`
#'
#' * Creates `R/utils-walkers.R` with base R pseudo-equivalents for `purrr`
#' `walk`/`walk2`

5
README.Rmd

@ -8,7 +8,7 @@ A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code
## Description
The 'tidyverse' is awesome, but can take a bit compile on systems
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
'tidyverse' functions that are mostly equivalent (some are more complete
@ -46,8 +46,7 @@ options(width=120)
```{r message=FALSE, warning=FALSE, error=FALSE}
library(freebase)
# current verison
# current version
packageVersion("freebase")
```

8
README.md

@ -5,9 +5,9 @@ A ‘usethis’-like Package for Base Pseudo-equivalents of ‘tidyverse’ Code
## Description
The ‘tidyverse’ is awesome, but can take a bit 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
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 ‘tidyverse’ functions that are mostly equivalent (some are more
complete than others). The base R counterpart functions will likely be
slower than the ‘tidyverse’ equivalents but using them will decrease
@ -44,7 +44,7 @@ devtools::install_github("hrbrmstr/freebase")
``` r
library(freebase)
# current verison
# current version
packageVersion("freebase")
```

6
docs/index.html

@ -10,7 +10,7 @@
<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">
<meta property="og:description" content="The 'tidyverse' is awesome, but can take a bit compile on systems
<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
'tidyverse' functions that are mostly equivalent (some are more complete
@ -83,7 +83,7 @@
<div id="description" class="section level2">
<h2 class="hasAnchor">
<a href="#description" class="anchor"></a>Description</h2>
<p>The ‘tidyverse’ is awesome, but can take a bit 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 ‘tidyverse’ functions that are mostly equivalent (some are more complete than others). The base R counterpart functions will likely be slower than the ‘tidyverse’ equivalents but using them will decrease ‘Imports’ dependencies.</p>
<p>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 ‘tidyverse’ functions that are mostly equivalent (some are more complete than others). The base R counterpart functions will likely be slower than the ‘tidyverse’ equivalents but using them will decrease ‘Imports’ dependencies.</p>
<p>Use deliberately and with caution.</p>
</div>
<div id="whats-inside-the-tin" class="section level2">
@ -119,7 +119,7 @@
<a href="#usage" class="anchor"></a>Usage</h2>
<div class="sourceCode" id="cb2"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb2-1" data-line-number="1"><span class="kw">library</span>(freebase)</a>
<a class="sourceLine" id="cb2-2" data-line-number="2"></a>
<a class="sourceLine" id="cb2-3" data-line-number="3"><span class="co"># current verison</span></a>
<a class="sourceLine" id="cb2-3" data-line-number="3"><span class="co"># current version</span></a>
<a class="sourceLine" id="cb2-4" data-line-number="4"><span class="kw">packageVersion</span>(<span class="st">"freebase"</span>)</a></code></pre></div>
<pre><code>## [1] '0.1.0'</code></pre>
</div>

2
docs/pkgdown.yml

@ -1,4 +1,4 @@
pandoc: '2.2'
pandoc: 2.2.1
pkgdown: 1.0.0
pkgdown_sha: ~
articles: []

4
docs/reference/freebase.html

@ -30,7 +30,7 @@
<meta property="og:title" content="A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code — freebase" />
<meta property="og:description" content="The 'tidyverse' is awesome, but can take a bit compile on systems
<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
'tidyverse' functions that are mostly equivalent (some are more complete
@ -110,7 +110,7 @@ dependencies. Use deliberately and with caution." />
<div class="ref-description">
<p>The 'tidyverse' is awesome, but can take a bit compile on systems
<p>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
'tidyverse' functions that are mostly equivalent (some are more complete

4
docs/reference/index.html

@ -158,13 +158,13 @@
<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></p></td>
<td><p>Use base R versions of <code>tidyr</code> <code>gather</code>/<code>spread</code>/<code>unite</code></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 keep/discard/compact</p></td>
<td><p>Use base-ified equivalents of <code>walk</code>/<code>walk2</code></p></td>
</tr>
</tbody>
</table>

2
docs/reference/use_isers.html

@ -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-detect.R</code>"</p></td>
<td><p>Where to save/what to name the file. Defaults to "<code>R/utils-isers.R</code>"</p></td>
</tr>
<tr>
<th>open</th>

10
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> — use_tidylite • freebase</title>
<title>Use base R versions of <code>tidyr</code> <code>gather</code>/<code>spread</code>/<code>unite</code> — 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> — use_tidylite" />
<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:description" content="
Creates R/utils-tidylite.R containing gatherlite() and spreadlite()
Creates R/utils-tidylite.R containing gatherlite(), spreadlite() and unitelite()
" />
<meta name="twitter:card" content="summary" />
@ -99,7 +99,7 @@ Creates R/utils-tidylite.R containing gatherlite() and spreadlite()
<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></h1>
<h1>Use base R versions of <code>tidyr</code> <code>gather</code>/<code>spread</code>/<code>unite</code></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() and spreadlite()
<div class="ref-description">
<ul>
<li><p>Creates <code>R/utils-tidylite.R</code> containing <code>gatherlite()</code> and <code>spreadlite()</code></p></li>
<li><p>Creates <code>R/utils-tidylite.R</code> containing <code>gatherlite()</code>, <code>spreadlite()</code> and <code>unitelite()</code></p></li>
</ul>
</div>

6
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 keep/discard/compact — use_walkers • freebase</title>
<title>Use base-ified equivalents of <code>walk</code>/<code>walk2</code> — use_walkers • 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="Use base-ified equivalents of keep/discard/compact — use_walkers" />
<meta property="og:title" content="Use base-ified equivalents of <code>walk</code>/<code>walk2</code> — use_walkers" />
<meta property="og:description" content="
Creates R/utils-walkers.R with base R pseudo-equivalents for purrr
@ -100,7 +100,7 @@ walk/walk2
<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-ified equivalents of <code>walk</code>/<code>walk2</code></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>

2
inst/templates/walkers.R

@ -1,4 +1,4 @@
# NOTE these aren't 100% equivalent to the purrr mappers but cover very common use-cases
# NOTE these aren't 100% equivalent to the purrr walkers but cover very common use-cases
#
# NOTE formula function (e.g. ~{}) are 100% supported

2
man/freebase.Rd

@ -6,7 +6,7 @@
\alias{freebase-package}
\title{A 'usethis'-like Package for Base Pseudo-equivalents of 'tidyverse' Code}
\description{
The 'tidyverse' is awesome, but can take a bit compile on systems
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
'tidyverse' functions that are mostly equivalent (some are more complete

2
man/use_isers.Rd

@ -7,7 +7,7 @@
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-detect.R}"}
\item{save_as}{Where to save/what to name the file. Defaults to "\code{R/utils-isers.R}"}
\item{open}{if \code{TRUE}, open the resultant file}
}

4
man/use_tidylite.Rd

@ -2,7 +2,7 @@
% 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}}
\title{Use base R versions of \code{tidyr} \code{gather}/\code{spread}/\code{unite}}
\usage{
use_tidylite(save_as = "R/utils-tidylite.R", open = TRUE)
}
@ -13,6 +13,6 @@ use_tidylite(save_as = "R/utils-tidylite.R", open = TRUE)
}
\description{
\itemize{
\item Creates \code{R/utils-tidylite.R} containing \code{gatherlite()} and \code{spreadlite()}
\item Creates \code{R/utils-tidylite.R} containing \code{gatherlite()}, \code{spreadlite()} and \code{unitelite()}
}
}

2
man/use_walkers.Rd

@ -2,7 +2,7 @@
% Please edit documentation in R/use-walkers.R
\name{use_walkers}
\alias{use_walkers}
\title{Use base-ified equivalents of keep/discard/compact}
\title{Use base-ified equivalents of \code{walk}/\code{walk2}}
\usage{
use_walkers(save_as = "R/utils-walkers.R", open = TRUE)
}

Loading…
Cancel
Save