Skip to content

Commit

Permalink
add citation file and suggestion in readme; close databio#45
Browse files Browse the repository at this point in the history
  • Loading branch information
vreuter committed Dec 13, 2019
1 parent 0164779 commit c66f315
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Expand Up @@ -77,6 +77,12 @@ paramount**. `simpleCache` assumes that your name for an object is a perfect
identifier for that object; in other words, don't cache things that you plan to
change.

### Citation

Please consider citing `simpleCache` if you use it in your research or project.

Sheffield et al., (2018). simpleCache: R caching for reproducible, distributed, large-scale projects. Journal of Open Source Software, 3(21), 463, https://doi.org/10.21105/joss.00463

### Contributing

`simpleCache` is licensed under the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause). Questions, feature requests and bug reports are welcome via the [issue queue](https://github.com/databio/simpleCache/issues). The maintainer will review pull requests and incorporate contributions at his discretion.
Expand Down
21 changes: 21 additions & 0 deletions inst/CITATION
@@ -0,0 +1,21 @@
citHeader("When using simpleCache in your work, please consider citing:")

citEntry(entry = "Article",
title = "{simpleCache}: R caching for reproducible, distributed, large-scale projects",
author = personList(as.person("VP Nagraj"),
as.person("Vince Reuter"),
as.person("Nathan Sheffield")),
journal = "Journal of Open Source Software",
year = "2019",
volume = "3",
number = "21",
pages = "463",
url = "https://doi.org/10.21105/joss.00463",

textVersion =
paste("VP Nagraj, Vince Reuter, Nathan Sheffield (2018).",
"simpleCache: R caching for reproducible, distributed, large-scale projects",
"Journal of Open Source Software, 3(21), 463.",
"URL https://doi.org/10.21105/joss.00463")
)

0 comments on commit c66f315

Please sign in to comment.