add FAQ on pkgs with several citations

.gitignore

@@ -11,3 +11,5 @@ test_nocite.Rmd
 docs
 peerj.csl
 grateful-report.html
+CRAN-SUBMISSION
+tests/testthat/test-installed_pkgs.R

README.Rmd

@@ -239,6 +239,11 @@ And these are the guidelines from the [Software Citation Checklist](https://doi.
 Apart from citing the software most relevant to the particular research/analysis performed, I think it is good idea to record the entire computational environment elsewhere, e.g. using `sessionInfo()` or `sessioninfo::session_info()`.
 
 
+### Some packages include several citations
+
+Some packages include more than one citation (e.g. [knitr](https://cran.r-project.org/web/packages/knitr/citation.html), [mgcv](https://cran.r-project.org/web/packages/mgcv/citation.html)). `grateful` will include all those citations by default, as it is impossible to decide automatically which citations should be included in each case. The user may manually remove citations from the produced reference list after calling `cite_packages`. If using Quarto or Rmarkdown, the unwanted references can be deleted from `grateful-refs.bib` so they will not appear cited.
+
+
 ### Removing unused packages
 
 Before running `grateful` you might want to run [`funchir::stale_package_check`](https://cran.r-project.org/package=funchir) or [annotater](https://cran.r-project.org/package=annotater) to check for unused packages before citing them.

README.md

@@ -41,12 +41,19 @@ included in the reference list when rendering.
 
 ## Installation
 
-You can install {grateful} from CRAN:
+You can install the stable release of {grateful} from CRAN:
 
 ``` r
 install.packages("grateful")
 ```
 
+Or the latest development version from
+[R-universe](https://pakillo.r-universe.dev/grateful):
+
+``` r
+install.packages("grateful", repos = c("https://pakillo.r-universe.dev", "https://cloud.r-project.org"))
+```
+
 Or from GitHub:
 
 ``` r
@@ -296,6 +303,18 @@ research/analysis performed, I think it is good idea to record the
 entire computational environment elsewhere, e.g. using `sessionInfo()`
 or `sessioninfo::session_info()`.
 
+### Some packages include several citations
+
+Some packages include more than one citation
+(e.g. [knitr](https://cran.r-project.org/web/packages/knitr/citation.html),
+[mgcv](https://cran.r-project.org/web/packages/mgcv/citation.html)).
+`grateful` will include all those citations by default, as it is
+impossible to decide automatically which citations should be included in
+each case. The user may manually remove citations from the produced
+reference list after calling `cite_packages`. If using Quarto or
+Rmarkdown, the unwanted references can be deleted from
+`grateful-refs.bib` so they will not appear cited.
+
 ### Removing unused packages
 
 Before running `grateful` you might want to run
@@ -332,15 +351,15 @@ Alternatively, use `.renvignore` to ignore certain files or folders (see
 citation("grateful")
 To cite package 'grateful' in publications use:
 
-  Rodriguez-Sanchez F, Jackson C (2023). _grateful: Facilitate citation
+  Rodriguez-Sanchez F, Jackson C (2024). _grateful: Facilitate citation
   of R packages_. <https://pakillo.github.io/grateful/>.
 
 A BibTeX entry for LaTeX users is
 
   @Manual{,
     title = {grateful: Facilitate citation of R packages},
     author = {Francisco Rodriguez-Sanchez and Connor P. Jackson},
-    year = {2023},
+    year = {2024},
     url = {https://pakillo.github.io/grateful/},
   }
 ```

inst/CITATION

@@ -6,7 +6,7 @@ bibentry(
                 person("Francisco", "Rodriguez-Sanchez"),
                 person("Connor P.", "Jackson")
                 ),
-  year         = "2023",
+  year         = "2024",
   url          = "https://pakillo.github.io/grateful/",
 )