Create Bibliography File

library(papillon)

Build a reference page

To award people hard working for open-source, it is always good to cite their work. In order to add an informative page in your Shiny applications for instance, you can create a html or markdown page listing all package dependencies used.

papillon::create_pkg_biblio_file(to = "html", out.dir = "inst")
# Can be included in a shiny app using 
shiny::includeHTML("bibliography.html")
# OR
papillon::create_pkg_biblio_file(to = "markdown")
# Can be included in a shiny app using 
shiny::includeMarkdown("bibliography.md")

Add references to this page

desc_file <- system.file("DESCRIPTION", package = "papillon")
out.dir <- tempdir()
papillon::create_pkg_biblio_file(
  path = desc_file, to = "html",
  out.dir = out.dir, edit = FALSE)
#> File /tmp/RtmpKfEbac/bibliography.html created
shiny::includeHTML(file.path(out.dir, "bibliography.html"))

List of dependencies

  • attachment (Rochette et al. (2024))
  • bookdown (Xie (2024a))
  • cli (Csárdi (2024a))
  • crayon (Csárdi (2024b))
  • desc (Csárdi, Müller, and Hester (2023))
  • devtools (Wickham et al. (2022))
  • knitr (Xie (2024b))
  • magrittr (Bache and Wickham (2022))
  • pkgdown (Wickham, Hesselberth, et al. (2024))
  • readr (Wickham, Hester, and Bryan (2024))
  • remotes (Csárdi et al. (2024))
  • rmarkdown (Allaire et al. (2024))
  • shiny (Chang et al. (2024))
  • testthat (Wickham (2024))
  • usethis (Wickham, Bryan, et al. (2024))
  • utils ((R-utils?))

References

Allaire, JJ, Yihui Xie, Christophe Dervieux, Jonathan McPherson, Javier Luraschi, Kevin Ushey, Aron Atkins, et al. 2024. Rmarkdown: Dynamic Documents for r. https://github.com/rstudio/rmarkdown.
Bache, Stefan Milton, and Hadley Wickham. 2022. Magrittr: A Forward-Pipe Operator for r. https://magrittr.tidyverse.org.
Chang, Winston, Joe Cheng, JJ Allaire, Carson Sievert, Barret Schloerke, Yihui Xie, Jeff Allen, Jonathan McPherson, Alan Dipert, and Barbara Borges. 2024. Shiny: Web Application Framework for r. https://shiny.posit.co/.
Csárdi, Gábor. 2024a. Cli: Helpers for Developing Command Line Interfaces. https://cli.r-lib.org.
———. 2024b. Crayon: Colored Terminal Output. https://r-lib.github.io/crayon/.
Csárdi, Gábor, Jim Hester, Hadley Wickham, Winston Chang, Martin Morgan, and Dan Tenenbaum. 2024. Remotes: R Package Installation from Remote Repositories, Including GitHub. https://remotes.r-lib.org.
Csárdi, Gábor, Kirill Müller, and Jim Hester. 2023. Desc: Manipulate DESCRIPTION Files. https://desc.r-lib.org/.
Rochette, Sébastien, Vincent Guyader, Murielle Delmotte, and Swann Floc’hlay. 2024. Attachment: Deal with Dependencies. https://thinkr-open.github.io/attachment/.
Wickham, Hadley. 2024. Testthat: Unit Testing for r. https://testthat.r-lib.org.
Wickham, Hadley, Jennifer Bryan, Malcolm Barrett, and Andy Teucher. 2024. Usethis: Automate Package and Project Setup. https://usethis.r-lib.org.
Wickham, Hadley, Jay Hesselberth, Maëlle Salmon, Olivier Roy, and Salim Brüggemann. 2024. Pkgdown: Make Static HTML Documentation for a Package. https://pkgdown.r-lib.org/.
Wickham, Hadley, Jim Hester, and Jennifer Bryan. 2024. Readr: Read Rectangular Text Data. https://readr.tidyverse.org.
Wickham, Hadley, Jim Hester, Winston Chang, and Jennifer Bryan. 2022. Devtools: Tools to Make Developing r Packages Easier. https://devtools.r-lib.org/.
Xie, Yihui. 2024a. Bookdown: Authoring Books and Technical Documents with r Markdown. https://github.com/rstudio/bookdown.
———. 2024b. Knitr: A General-Purpose Package for Dynamic Report Generation in r. https://yihui.org/knitr/.