From f2dd3a9dc7e5ba92003f8f4ee21d5d33e789877e Mon Sep 17 00:00:00 2001 From: Rich FitzJohn Date: Tue, 22 Oct 2024 09:27:05 +0100 Subject: [PATCH] Redocument --- R/outpack_tools.R | 6 +++++- man/orderly_copy_files.Rd | 2 +- man/orderly_interactive_set_search_options.Rd | 2 +- man/orderly_metadata_extract.Rd | 8 ++++++-- man/orderly_query_explain.Rd | 2 +- man/orderly_run.Rd | 2 +- man/orderly_search.Rd | 2 +- 7 files changed, 16 insertions(+), 8 deletions(-) diff --git a/R/outpack_tools.R b/R/outpack_tools.R index 3d28b537..cb8760cd 100644 --- a/R/outpack_tools.R +++ b/R/outpack_tools.R @@ -102,7 +102,11 @@ ##' are more complex, these will be list columns. ##' ##' You must not provide `id`; it is always returned and always first -##' as a character vector column. +##' as a character vector column. If your extraction could possibly +##' return data from locations (i.e., you have `allow_remote = TRUE` +##' or have given a value for `location`) then we add a logical column +##' `local` which indicates if the packet is local to your archive, +##' meaning that you have all the files from it locally. ##' ##' You can rename the columns by providing a name to entries within ##' `extract`, for example: diff --git a/man/orderly_copy_files.Rd b/man/orderly_copy_files.Rd index bcc8808b..bc8e9abe 100644 --- a/man/orderly_copy_files.Rd +++ b/man/orderly_copy_files.Rd @@ -67,7 +67,7 @@ might in future expand this to allow wildcards or exceptions.} to be found that are not currently unpacked (i.e., are known only to a location that we have metadata from). If this is \code{TRUE}, then in conjunction with \link{orderly_dependency} -you might pull a large quantity of data. The default \code{NULL} is +you might pull a large quantity of data. The default is \code{NULL}. This is \code{TRUE} if remote locations are listed explicitly as a character vector in the \code{location} argument, or if you have specified \code{pull_metadata = TRUE}, otherwise \code{FALSE}.} diff --git a/man/orderly_interactive_set_search_options.Rd b/man/orderly_interactive_set_search_options.Rd index 3b9414d0..02290ba6 100644 --- a/man/orderly_interactive_set_search_options.Rd +++ b/man/orderly_interactive_set_search_options.Rd @@ -18,7 +18,7 @@ might in future expand this to allow wildcards or exceptions.} to be found that are not currently unpacked (i.e., are known only to a location that we have metadata from). If this is \code{TRUE}, then in conjunction with \link{orderly_dependency} -you might pull a large quantity of data. The default \code{NULL} is +you might pull a large quantity of data. The default is \code{NULL}. This is \code{TRUE} if remote locations are listed explicitly as a character vector in the \code{location} argument, or if you have specified \code{pull_metadata = TRUE}, otherwise \code{FALSE}.} diff --git a/man/orderly_metadata_extract.Rd b/man/orderly_metadata_extract.Rd index 421dfa52..a9c43c61 100644 --- a/man/orderly_metadata_extract.Rd +++ b/man/orderly_metadata_extract.Rd @@ -29,7 +29,7 @@ might in future expand this to allow wildcards or exceptions.} to be found that are not currently unpacked (i.e., are known only to a location that we have metadata from). If this is \code{TRUE}, then in conjunction with \link{orderly_dependency} -you might pull a large quantity of data. The default \code{NULL} is +you might pull a large quantity of data. The default is \code{NULL}. This is \code{TRUE} if remote locations are listed explicitly as a character vector in the \code{location} argument, or if you have specified \code{pull_metadata = TRUE}, otherwise \code{FALSE}.} @@ -170,7 +170,11 @@ will be a character vector, but because \code{parameters} and \code{files} are more complex, these will be list columns. You must not provide \code{id}; it is always returned and always first -as a character vector column. +as a character vector column. If your extraction could possibly +return data from locations (i.e., you have \code{allow_remote = TRUE} +or have given a value for \code{location}) then we add a logical column +\code{local} which indicates if the packet is local to your archive, +meaning that you have all the files from it locally. You can rename the columns by providing a name to entries within \code{extract}, for example: diff --git a/man/orderly_query_explain.Rd b/man/orderly_query_explain.Rd index 83bce048..a1fb9a7b 100644 --- a/man/orderly_query_explain.Rd +++ b/man/orderly_query_explain.Rd @@ -44,7 +44,7 @@ might in future expand this to allow wildcards or exceptions.} to be found that are not currently unpacked (i.e., are known only to a location that we have metadata from). If this is \code{TRUE}, then in conjunction with \link{orderly_dependency} -you might pull a large quantity of data. The default \code{NULL} is +you might pull a large quantity of data. The default is \code{NULL}. This is \code{TRUE} if remote locations are listed explicitly as a character vector in the \code{location} argument, or if you have specified \code{pull_metadata = TRUE}, otherwise \code{FALSE}.} diff --git a/man/orderly_run.Rd b/man/orderly_run.Rd index 65e7e042..5173ee82 100644 --- a/man/orderly_run.Rd +++ b/man/orderly_run.Rd @@ -39,7 +39,7 @@ might in future expand this to allow wildcards or exceptions.} to be found that are not currently unpacked (i.e., are known only to a location that we have metadata from). If this is \code{TRUE}, then in conjunction with \link{orderly_dependency} -you might pull a large quantity of data. The default \code{NULL} is +you might pull a large quantity of data. The default is \code{NULL}. This is \code{TRUE} if remote locations are listed explicitly as a character vector in the \code{location} argument, or if you have specified \code{pull_metadata = TRUE}, otherwise \code{FALSE}.} diff --git a/man/orderly_search.Rd b/man/orderly_search.Rd index 8dc90f24..0413e553 100644 --- a/man/orderly_search.Rd +++ b/man/orderly_search.Rd @@ -46,7 +46,7 @@ might in future expand this to allow wildcards or exceptions.} to be found that are not currently unpacked (i.e., are known only to a location that we have metadata from). If this is \code{TRUE}, then in conjunction with \link{orderly_dependency} -you might pull a large quantity of data. The default \code{NULL} is +you might pull a large quantity of data. The default is \code{NULL}. This is \code{TRUE} if remote locations are listed explicitly as a character vector in the \code{location} argument, or if you have specified \code{pull_metadata = TRUE}, otherwise \code{FALSE}.}