From a6790735216e9b56d88eca91381456741edf6d26 Mon Sep 17 00:00:00 2001 From: Jordan Bradford <36420801+jrdnbradford@users.noreply.github.com> Date: Mon, 8 Jul 2024 21:35:25 -0400 Subject: [PATCH 1/2] Add `CITATION` --- .gitignore | 2 ++ DESCRIPTION | 2 +- README.md | 21 +++++++++++++++++++++ README.qmd | 8 ++++++++ inst/CITATION | 7 +++++++ 5 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 inst/CITATION diff --git a/.gitignore b/.gitignore index 5b6a065..cba43cc 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,5 @@ .Rhistory .RData .Ruserdata + +/.quarto/ diff --git a/DESCRIPTION b/DESCRIPTION index 47f39de..ead8e0b 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -4,7 +4,7 @@ Title: H. P. Lovecraft's works, for text analysis Version: 0.1.3 Authors@R: person("Jordan", "Bradford", email = "jrdnbradford@gmail.com", role = c("aut", "cre")) -Description: A collection of H. P. Lovecraft's works as R datasets +Description: A collection of H. P. Lovecraft's works as R datasets. URL: https://github.com/jrdnbradford/lovecraftr BugReports: https://github.com/jrdnbradford/lovecraftr/issues License: MIT + file LICENSE diff --git a/README.md b/README.md index f293fa2..a256bd1 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,27 @@ data("lovecraft") See [CONTRIBUTING.md](./.github/CONTRIBUTING.md). +## Citation + +Please cite this package if you use it. + +``` r +citation("lovecraftr") +#> To cite package 'lovecraftr' in publications use: +#> +#> Bradford J (2024). _lovecraftr: H. P. Lovecraft's works, for text +#> analysis_. . +#> +#> A BibTeX entry for LaTeX users is +#> +#> @Manual{, +#> title = {lovecraftr: H. P. Lovecraft's works, for text analysis}, +#> author = {Jordan Bradford}, +#> year = {2024}, +#> url = {https://github.com/jrdnbradford/lovecraftr/}, +#> } +``` + ## H. P. Lovecraft Datasets | Title | TXT | RDA | diff --git a/README.qmd b/README.qmd index c66e6e1..7298f38 100644 --- a/README.qmd +++ b/README.qmd @@ -71,6 +71,14 @@ data("lovecraft") See [CONTRIBUTING.md](/.github/CONTRIBUTING.md). +## Citation + +Please cite this package if you use it. + +```{R citation, echo=TRUE, eval=TRUE} +citation("lovecraftr") +``` + ## H. P. Lovecraft Datasets ```{R file-table-setup, output=FALSE, echo=FALSE, eval=TRUE} diff --git a/inst/CITATION b/inst/CITATION new file mode 100644 index 0000000..10352e9 --- /dev/null +++ b/inst/CITATION @@ -0,0 +1,7 @@ +bibentry( + bibtype = "Manual", + title = "lovecraftr: H. P. Lovecraft's works, for text analysis", + author = c(person("Jordan", "Bradford")), + year = "2024", + url = "https://github.com/jrdnbradford/lovecraftr/", +) From 73ecb89ad93051fbf2ed664cd8c6e54551f16f2c Mon Sep 17 00:00:00 2001 From: Jordan Bradford <36420801+jrdnbradford@users.noreply.github.com> Date: Mon, 8 Jul 2024 21:36:17 -0400 Subject: [PATCH 2/2] Add `.qmd` to `.Rbuildignore` --- .Rbuildignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.Rbuildignore b/.Rbuildignore index eee53f1..d7fa1ac 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,5 +1,6 @@ ^renv$ ^renv\.lock$ +^README\.qmd$ ^.*\.Rproj$ ^.Rhistory$ ^\.Rproj\.user$