Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CITATION file #25

Merged
merged 2 commits into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
^renv$
^renv\.lock$
^README\.qmd$
^.*\.Rproj$
^.Rhistory$
^\.Rproj\.user$
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@
.Rhistory
.RData
.Ruserdata

/.quarto/
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
8 changes: 8 additions & 0 deletions README.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
7 changes: 7 additions & 0 deletions inst/CITATION
Original file line number Diff line number Diff line change
@@ -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/",
)