From b5c329095fd15570e151d56253f420fb6974e8a4 Mon Sep 17 00:00:00 2001 From: Mantra Date: Wed, 24 Jan 2024 19:08:18 +0000 Subject: [PATCH] update docs --- man/orderly_cleanup.Rd | 3 ++- man/orderly_list_src.Rd | 4 ++-- man/orderly_new.Rd | 2 +- man/orderly_parameters.Rd | 4 ++-- man/orderly_plugin_register.Rd | 4 ++-- 5 files changed, 9 insertions(+), 8 deletions(-) diff --git a/man/orderly_cleanup.Rd b/man/orderly_cleanup.Rd index fcf100a6..96fbdcb9 100644 --- a/man/orderly_cleanup.Rd +++ b/man/orderly_cleanup.Rd @@ -70,7 +70,8 @@ path <- orderly2::orderly_example("default") # We simulate running a packet interactively by using 'source'; # you might have run this line-by-line, or with the "Source" -# button in Rstudio. +# button in Rstudio (remember to use '.R' instead +# of 'orderly.R' if you decided to call your orderly file that). source(file.path(path, "src/data/orderly.R"), chdir = TRUE) # Having run this, the output of the report is present in the diff --git a/man/orderly_list_src.Rd b/man/orderly_list_src.Rd index 340959ba..ab65cadf 100644 --- a/man/orderly_list_src.Rd +++ b/man/orderly_list_src.Rd @@ -23,8 +23,8 @@ A character vector of names of source reports, suitable for passing to \link{orderly_run} } \description{ -List source reports - that is, directories within \verb{src/} that -contain a file \code{orderly.R} +List source reports - that is, directories \verb{src/} that +contain one of \verb{.R} or \code{orderly.R} } \examples{ path <- orderly2::orderly_example("default") diff --git a/man/orderly_new.Rd b/man/orderly_new.Rd index 70061900..6e0f93b6 100644 --- a/man/orderly_new.Rd +++ b/man/orderly_new.Rd @@ -14,7 +14,7 @@ for now are \code{NULL} (uses the built-in default) and \code{FALSE} which suppresses any default content. We may support customisable templates in future - let us know if this would be useful.} -\item{force}{Create an \code{orderly.R} file within an existing +\item{force}{Create a \verb{.R} file within an existing directory \verb{src/}; this may be useful if you have already created the directory and some files first but want help creating the orderly file.} diff --git a/man/orderly_parameters.Rd b/man/orderly_parameters.Rd index e8c32b21..d2a66fe0 100644 --- a/man/orderly_parameters.Rd +++ b/man/orderly_parameters.Rd @@ -24,8 +24,8 @@ have a default, in which case this parameter will be required. \section{Behaviour in interactive sessions}{ -When running interactively (i.e., via \code{source()} or running an -\code{orderly.R} session by copy/paste or in Rstudio), the +When running interactively (i.e., via \code{source()} or running a +\verb{.R}/\code{orderly.R} session by copy/paste or in Rstudio), the \code{orderly_parameters()} function has different behaviour. First, we look in the current environment (most likely the global diff --git a/man/orderly_plugin_register.Rd b/man/orderly_plugin_register.Rd index dbb0d92a..60267a4e 100644 --- a/man/orderly_plugin_register.Rd +++ b/man/orderly_plugin_register.Rd @@ -43,7 +43,7 @@ etc), and will make your plugin nicer to work with \code{\link[=orderly_metadata_extract]{orderly_metadata_extract()}}. This function will be given a single argument \code{data} which is the data from \code{jsonlite::fromJSON(..., simplifyVector = FALSE)} and you should -apply and required simplifications yourself, returning a +apply any required simplifications yourself, returning a modified copy of the argument.} \item{cleanup}{Optionally, a function to clean up any state that @@ -64,7 +64,7 @@ registering a plugin. \description{ Create an orderly plugin. A plugin is typically defined by a package and is used to extend orderly by enabling new -functionality, declared in \code{orderly_config.yml} and \code{orderly.R} +functionality, declared in \code{orderly_config.yml} and \verb{.R}/\code{orderly.R} and affecting the running of reports primarily by creating new objects in the report environment. This system is discussed in more detail in \code{vignette("plugins")}, but will be expanded (likely