Explain how to cite R together with a given list of packages. Close #37

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: grateful
 Title: Facilitate Citation of R Packages
-Version: 0.2.5
+Version: 0.2.6
 Authors@R: c(
     person("Francisco", "Rodriguez-Sanchez", 
             email = "[email protected]", 

NEWS.md

@@ -1,4 +1,8 @@
 
+# grateful 0.2.6
+
+* Explain how to cite R together with a given list of packages (issue #37).
+
 # grateful 0.2.5
 
 * Fixed a bug in writing passive voice paragraph when generating a citation report (issue #39).

R/cite_packages.R

@@ -84,7 +84,8 @@
 #' within the project/folder (the default), or "Session" to include only packages
 #' used in the current session.
 #' Alternatively, `pkgs` can also be a character vector of package names to
-#' get citations for (see examples).
+#' get citations for. To cite R as well as the given packages,
+#' include "base" in `pkgs` (see examples).
 #'
 #' @param omit Character vector of package names to be omitted from the citation
 #' report. `grateful` is omitted by default. Use `omit = NULL` to include all
@@ -138,6 +139,9 @@
 #' # Cite only user-provided packages:
 #' cite_packages(pkgs = c("renv", "remotes", "knitr"), out.dir = tempdir())
 #'
+#' # Cite R as well as user-provided packages
+#' cite_packages(pkgs = c("base", "renv", "remotes", "knitr"), out.dir = tempdir())
+#'
 #'
 #' # To include citations in an R Markdown or Quarto file
 #'

README.Rmd

@@ -17,6 +17,7 @@ knitr::opts_chunk$set(
 <!-- badges: start -->
 `r badger::badge_cran_release()`
 ![](https://img.shields.io/github/r-package/v/Pakillo/grateful)
+<a href="https://diffify.com/R/grateful" target="_blank"><img src="https://diffify.com/diffify-badge.svg" alt="The diffify page for the R package grateful" style="width: 100px; max-width: 100%;"></a>
 [![R-CMD-check](https://github.com/Pakillo/grateful/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Pakillo/grateful/actions/workflows/R-CMD-check.yaml)
 [![Codecov test coverage](https://codecov.io/gh/Pakillo/grateful/branch/master/graph/badge.svg)](https://app.codecov.io/gh/Pakillo/grateful?branch=master)
 `r badger::badge_lifecycle("stable")`

README.md

@@ -7,6 +7,7 @@
 
 [![](https://www.r-pkg.org/badges/version/grateful)](https://cran.r-project.org/package=grateful)
 ![](https://img.shields.io/github/r-package/v/Pakillo/grateful)
+<a href="https://diffify.com/R/grateful" target="_blank"><img src="https://diffify.com/diffify-badge.svg" alt="The diffify page for the R package grateful" style="width: 100px; max-width: 100%;"></a>
 [![R-CMD-check](https://github.com/Pakillo/grateful/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Pakillo/grateful/actions/workflows/R-CMD-check.yaml)
 [![Codecov test
 coverage](https://codecov.io/gh/Pakillo/grateful/branch/master/graph/badge.svg)](https://app.codecov.io/gh/Pakillo/grateful?branch=master)