From 5a7cafd76f38618eb24ad279e54bb40507c539a4 Mon Sep 17 00:00:00 2001 From: Rich FitzJohn Date: Thu, 19 Dec 2024 15:00:12 +0000 Subject: [PATCH] Make orderly_resource docs more explicit --- DESCRIPTION | 2 +- R/metadata.R | 4 +++- man/orderly_resource.Rd | 4 +++- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 990bbff8..9d3af7d7 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: orderly2 Title: Orderly Next Generation -Version: 1.99.59 +Version: 1.99.60 Authors@R: c(person("Rich", "FitzJohn", role = c("aut", "cre"), email = "rich.fitzjohn@gmail.com"), person("Robert", "Ashton", role = "aut"), diff --git a/R/metadata.R b/R/metadata.R index 2fcc425f..0bab1979 100644 --- a/R/metadata.R +++ b/R/metadata.R @@ -155,7 +155,9 @@ static_orderly_description <- function(args) { ##' ##' @title Declare orderly resources ##' -##' @param files Any number of names of files +##' @param files Any number of names of files or directories. If you +##' list a directory it is expanded recursively to include all +##' subdirectories and files. ##' ##' @return Invisibly, a character vector of resources included by the ##' call. Don't rely on the order of these files if they are diff --git a/man/orderly_resource.Rd b/man/orderly_resource.Rd index 4473b43e..baaf8de3 100644 --- a/man/orderly_resource.Rd +++ b/man/orderly_resource.Rd @@ -7,7 +7,9 @@ orderly_resource(files) } \arguments{ -\item{files}{Any number of names of files} +\item{files}{Any number of names of files or directories. If you +list a directory it is expanded recursively to include all +subdirectories and files.} } \value{ Invisibly, a character vector of resources included by the