add wrapper function cite_packages

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(cite_packages)
 export(create_rmd)
 export(get_citations)
 export(get_csl)

R/cite_packages.R

@@ -0,0 +1,28 @@
+#' Cite R packages used in a project
+#'
+#' This is a wrapper function.
+#'
+#' @param all.pkg Logical. Include all packages used in scripts within the project/folder (the default), or only packages used in the current session? If TRUE, uses \code{\link[checkpoint]{scanForPackages}}, otherwise uses \code{\link[utils]{sessionInfo}}.
+#' @param include.rmd Logical. Include packages used in Rmarkdown documents? (default is TRUE, requires \code{knitr} package).
+#' @param style Optional. Citation style to format references. See \url{http://citationstyles.org/styles/}.
+#' @param out.format Output format, either "word", "pdf", "html", or "md" (markdown).
+#' @param ... Other parameters passed to \code{\link[checkpoint]{scanForPackages}}.
+#'
+#' @return A document with rendered citations in the desired format, plus a file ("pkg-refs.bib") containing references in BibTeX format.
+#' @export
+#'
+#' @examples
+#' library(grateful)
+#' cite_packages()
+#'
+cite_packages <- function(all.pkg = TRUE, include.rmd = TRUE, style = NULL,
+                          out.format = "html", ...) {
+
+  pkgs <- scan_packages(all.pkgs = all.pkg, include.Rmd = include.rmd, ...)
+  cites <- get_citations(pkgs) # produces "pkg-refs.bib" file
+  rmd <- create_rmd(cites, csl = style)  # produces "refs.Rmd"
+  render_citations(rmd, output = out.format)
+
+  file.remove(rmd)
+
+}