diff --git a/README.md b/README.md index faf1a06..86c2f05 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/inst/CITATION b/inst/CITATION new file mode 100644 index 0000000..35b0968 --- /dev/null +++ b/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 = "2018", + 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") +) +