-
The list of 'base' packages are now retrieved via
installed.packages(priority = "base")rather thansessionInfo()$basePkgs, which should be more robust since not all base packages are automatically attached in every session (e.g. 'grid'). Fixes #84. Thanks @inigourrestarazu for reporting. -
Avoid duplication of R base citation when base R packages are provided as a vector (e.g.
cite_packages(pkgs = c("grid", "splines"))) -
Fixes citation paragraph when there are no packages to cite (only base R).
-
Now possible to scan and cite dependencies from a package DESCRIPTION file (#62). Use
pkgs = c("Depends", "Imports", "Suggests", "LinkingTo")or combinations of them to choose which dependencies to cite. -
Now possible to scan and cite dependencies from a single R script, 'Rmarkdown' or 'Quarto' document #65. Just provide the path to the file to the
pkgsargument. -
Now possible to customise the language of citation paragraphs (#55), thanks to new arguments to
cite_packages:text.start,text.pksandtext.RStudio. -
New logical argument
skip.missingallows the user to skip missing packages (those used somewhere in the project but not currently installed) #54. -
Slow down requests when querying dependencies for a large number of packages #61.
- Fix generation of citation keys under R 4.5.0 (issue #59).
- Revise tests (issue #57).
- Add support for LaTeX output (thanks @patrick-weiss for the suggestion). Use
out.format = "tex-document"to obtain a full LaTeX document, orout.format = "tex-fragment"to produce just a fragment citing packages to be copied into another existing LaTeX document.
- Match package names with citation keys explicitly, rather than relying on sorting.
- Fix problem with citation keys containing non-alphanumeric characters (-) (issue #44, thanks @jkylearmstrong).
- Enable citing Rstudio with 'table' output format (issue #41).
- Explain how to cite R together with a given list of packages (issue #37).
- Fixed a bug in writing passive voice paragraph when generating a citation report (issue #39).
- Fixed a bug in package doc (cf. r-lib/roxygen2#1491).
- Fixed a bug when downloading 'dependent' citation styles from the official repository.
- Removed some tests that were likely to fail in the future (issue #36)
- Citation paragraph can now be written in passive voice, thanks to @jmclawson
-
Added
omitargument to exclude some packages from the citation report. -
Argument
cite.gratefulhas been removed, useomit = c("grateful")instead. -
Increased robustness: more tests and argument checks added.
-
out.dirmust now be provided by the user (out.dir = getwd()not allowed per CRAN policy) -
Rmd.fileandout.namearguments tocite_packageshave been fused into a singleout.fileargument -
CITATION now uses bibentry rather than citEntry.
-
Fully revised documentation and README, including examples of running grateful with Quarto.
-
Added many tests
-
When using grateful within 'R Markdown', it is no longer necessary to specify chunk option
results = "asis"(thanks to @connorp)
- Fixed bug when matching citekeys with package names containing punctuation characters.
- Fixed potential bug when matching package names with citation keys. Now using more strict regex.
- New option output = "table" to produce a table with package names, version, and citation, to be used within an 'R Markdown' document.
-
Now including package versions, besides package name.
-
For packages specifying more than one reference in their CITATION file, use all of them.
-
Rather than a list of package names, grateful now returns a text paragraph citing R and all the used packages, ready to be pasted in a manuscript or report.
-
Now including base R citation in all cases. Can optionally add RStudio too.
-
grateful can now be used within 'R Markdown'. Including a chunk with
cite_packages(output = "paragraph")will introduce a paragraph with in-text citations of R and the used packages, and their citations will be formatted when rendering the 'R Markdown' document. -
It is also possible to cite particular packages using their BibTeX keys generated by grateful. Or include them in the reference list without citing them in-text, using the new
nocite_references()function. -
New argument
cite.tidyverseto collapse citations of all used tidyverse packages into a single citation to 'tidyverse'. -
New argument
dependenciesto include package dependencies in the citation list.