Merge pull request #326 from vimc/vimc-7040

add orderly_packages method

Author: richfitz

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: orderly
 Title: Lightweight Reproducible Reporting
-Version: 1.5.1
+Version: 1.6.0
 Description: Order, create and store reports from R.  By defining a
     lightweight interface around the inputs and outputs of an
     analysis, a lot of the repetitive work for reproducible research
@@ -46,7 +46,7 @@ Suggests:
     rmarkdown,
     testthat,
     vaultr (>= 1.0.4)
-RoxygenNote: 7.2.0
+RoxygenNote: 7.2.3
 Roxygen: list(markdown = TRUE)
 VignetteBuilder: knitr
 Language: en-GB

NAMESPACE

@@ -35,6 +35,7 @@ export(orderly_log_off)
 export(orderly_log_on)
 export(orderly_migrate)
 export(orderly_new)
+export(orderly_packages)
 export(orderly_pull_archive)
 export(orderly_pull_dependencies)
 export(orderly_push_archive)

R/info.R

@@ -71,3 +71,21 @@ orderly_info <- function(id, name, root = NULL, locate = TRUE) {
     error = error
   )
 }
+
+##' Return details of packages required by all src reports in this orderly repo
+##'
+##' @inheritParams orderly_list
+##'
+##' @return List of packages required by all src reports
+##' @export
+##'
+##' @examples
+##' path <- orderly::orderly_example("minimal")
+##' orderly::orderly_packages(root = path)
+orderly_packages <- function(root = NULL, locate = TRUE) {
+  cfg <- orderly_config(root, locate)
+  names <- basename(list_dirs(path_src(cfg$root)))
+  packages <- lapply(names,
+                     function(name) orderly_recipe$new(name, cfg)$packages)
+  unique(as.list(unlist(packages)))
+}

_pkgdown.yml

@@ -99,6 +99,7 @@ reference:
     contents:
       - orderly_example
       - orderly_run_info
+      - orderly_packages
       - orderly_log
       - orderly_log_off
       - orderly_log_on

inst/examples/minimal/src/example/orderly.yml

@@ -6,3 +6,4 @@ artefacts:
   staticgraph:
     description: A graph of things
     filenames: mygraph.png
+

inst/examples/minimal/src/example2/orderly.yml

@@ -0,0 +1,10 @@
+data:
+  dat:
+    query: SELECT name, number FROM thing
+script: script.R
+artefacts:
+  staticgraph:
+    description: A graph of things
+    filenames: mygraph.png
+packages:
+  - withr

inst/examples/minimal/src/example2/script.R

@@ -0,0 +1,4 @@
+png("mygraph.png")
+par(mar = c(15, 4, .5, .5))
+barplot(setNames(dat$number, dat$name), las = 2)
+dev.off()