Merge pull request #25 from jrdnbradford/add-citation

Add citation

.Rbuildignore

@@ -1,5 +1,6 @@
 ^renv$
 ^renv\.lock$
+^README\.qmd$
 ^.*\.Rproj$
 ^.Rhistory$
 ^\.Rproj\.user$

.gitignore

@@ -2,3 +2,5 @@
 .Rhistory
 .RData
 .Ruserdata
+
+/.quarto/

DESCRIPTION

@@ -4,7 +4,7 @@ Title: H. P. Lovecraft's works, for text analysis
 Version: 0.1.3
 Authors@R:
     person("Jordan", "Bradford", email = "[email protected]", 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

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_. <https://github.com/jrdnbradford/lovecraftr/>.
+#> 
+#> 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 |

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}

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/",
+)