Skip to content

Commit

Permalink
doc: spelling typos
Browse files Browse the repository at this point in the history
  • Loading branch information
jhrcook committed Mar 26, 2020
1 parent cc80f76 commit 7e3dc2e
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 22 deletions.
Binary file modified .mustashe/rnd_vals.rds
Binary file not shown.
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ foo

---

### Attirubiton
### Attribution

The inspiration for this package came from the `cache()` feature in the ['ProjectTemplate'](http://projecttemplate.net/index.html) package.
While the functionality and implementation are a bit different, this would have been far more difficult to do without referencing the source code from 'ProjectTemplate'.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ stash("rnd_vals", {
})
#> Stashing object.
tictoc::toc()
#> random simulation: 3.752 sec elapsed
#> random simulation: 3.382 sec elapsed
```

Now, if we come back tomorrow and continue working on the same analysis,
Expand All @@ -83,7 +83,7 @@ stash("rnd_vals", {
})
#> Loading stashed object.
tictoc::toc()
#> random simulation: 0.138 sec elapsed
#> random simulation: 0.053 sec elapsed
```

## Dependencies
Expand Down Expand Up @@ -145,7 +145,7 @@ foo

-----

### Attirubiton
### Attribution

The inspiration for this package came from the `cache()` feature in the
[‘ProjectTemplate’](http://projecttemplate.net/index.html) package.
Expand Down
16 changes: 8 additions & 8 deletions docs/articles/getting-started.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 11 additions & 1 deletion inst/WORDLIST
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
AppVeyor
Codecov
stashR’
env
formatR
mustashe’
ProjectTemplate
ProjectTemplate's
ProjectTemplate’
reproducibly
RStudio
tictoc
tictoc’
unevaluated
Unstash
Unstashing
1 change: 1 addition & 0 deletions mustashe.Rproj
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ StripTrailingWhitespace: Yes
BuildType: Package
PackageUseDevtools: Yes
PackageInstallArgs: --no-multiarch --with-keep.source
PackageCheckArgs: --as-cran
PackageRoxygenize: rd,collate,namespace
10 changes: 5 additions & 5 deletions vignettes/getting-started.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ In other words, the first time a chunk of code is evaluated, the output can be *

## Basic example

Below is a breif example outlining the use of the primary function from the package, `stash()`.
Below is a brief example outlining the use of the primary function from the package, `stash()`.
First we must load the 'mustashe' library.

```{r}
Expand Down Expand Up @@ -93,7 +93,7 @@ I did this and thought it was working: on the first pass it would cache the resu
However, in a new session of R, it would not just load from the cache, but, instead, evaluate the code and cache the results.
After a bit of exploring the `cache()` source code, I realized the problem was that 'ProjectTemplate' compares the current value of the object to be cached with the object that is cached.
Of course, this requires the object to be in the environment already, which it is in a 'ProjectTemplate' system after running `load.project()` because that loads the cache (lazily) into the R environment.
I do not want this behaviour, and thus the caching system used by 'ProjectTemplate' was insufficient for my needs.
I do not want this behavior, and thus the caching system used by 'ProjectTemplate' was insufficient for my needs.

That said, I *heavily* relied upon the code for `cache()` when creating `stash()`.
This would have been far more difficult to do without reference to 'ProjectTemplate'.
Expand All @@ -103,7 +103,7 @@ This would have been far more difficult to do without reference to 'ProjectTempl

There are two major features of the `stash()` function from 'mustashe' not covered in the basic example above:

1. 'mustashe' "remembers" the code passed to `stash()` and will re-evalute the code if it has changed.
1. 'mustashe' "remembers" the code passed to `stash()` and will re-evaluate the code if it has changed.
2. Dependencies can be explicitly linked to the stashed object so that the code is re-evaluated if the dependencies change.

These two features are demonstrated below.
Expand Down Expand Up @@ -157,8 +157,8 @@ a=runif( 10 ) # Another comment

### Dependencies

Dependencies can be explcitly linked to an object to make sure that if they change, the stashed object is re-evaluated.
"Dependency" in this case could refer to data frames that are used to create another (e.g. summarising a data frame's columns), inputs to a function, etc.
Dependencies can be explicitly linked to an object to make sure that if they change, the stashed object is re-evaluated.
"Dependency" in this case could refer to data frames that are used to create another (e.g. summarizing a data frame's columns), inputs to a function, etc.

The following demonstrates this with a simple example where `x` is used to calculate `y`.
By passing `"x"` to the `depends_on` argument, when the value of `x` is changed, the code to create `y` is re-evaluated
Expand Down

0 comments on commit 7e3dc2e

Please sign in to comment.