Create Bibliography File

Source: vignettes/ac-create-bibliography-file.Rmd

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/RtmpYrS2lH/bibliography.html created
shiny::includeHTML(file.path(out.dir, "bibliography.html"))

List of dependencies

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

References

Allaire, JJ, Yihui Xie, Jonathan McPherson, Javier Luraschi, Kevin Ushey, Aron Atkins, Hadley Wickham, Joe Cheng, Winston Chang, and Richard Iannone. 2023. Rmarkdown: Dynamic Documents for r.
Bache, Stefan Milton, and Hadley Wickham. 2022. Magrittr: A Forward-Pipe Operator for r.
Chang, Winston, Joe Cheng, JJ Allaire, Carson Sievert, Barret Schloerke, Yihui Xie, Jeff Allen, Jonathan McPherson, Alan Dipert, and Barbara Borges. 2022. Shiny: Web Application Framework for r. https://shiny.rstudio.com/.
Csárdi, Gábor. 2022. Crayon: Colored Terminal Output. https://github.com/r-lib/crayon#readme.
———. 2023. Cli: Helpers for Developing Command Line Interfaces.
Csárdi, Gábor, Jim Hester, Hadley Wickham, Winston Chang, Martin Morgan, and Dan Tenenbaum. 2021. Remotes: R Package Installation from Remote Repositories, Including GitHub.
Csárdi, Gábor, Kirill Müller, and Jim Hester. 2022. Desc: Manipulate DESCRIPTION Files.
Rochette, Sébastien, and Vincent Guyader. 2023. Attachment: Deal with Dependencies. https://CRAN.R-project.org/package=attachment.
Wickham, Hadley, Jennifer Bryan, and Malcolm Barrett. 2022. Usethis: Automate Package and Project Setup.
Wickham, Hadley, Jay Hesselberth, and Maëlle Salmon. 2022. Pkgdown: Make Static HTML Documentation for a Package.
Wickham, Hadley, Jim Hester, and Jennifer Bryan. 2022. Readr: Read Rectangular Text Data.
Wickham, Hadley, Jim Hester, Winston Chang, and Jennifer Bryan. 2022. Devtools: Tools to Make Developing r Packages Easier.
Xie, Yihui. 2023a. Bookdown: Authoring Books and Technical Documents with r Markdown.
———. 2023b. Knitr: A General-Purpose Package for Dynamic Report Generation in r. https://yihui.org/knitr/.