From 80a7576557affcdab2cbfebe54d3cfffba52de0f 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_metadata_extract.Rd | 6 +++++- 2 files changed, 10 insertions(+), 2 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_metadata_extract.Rd b/man/orderly_metadata_extract.Rd index 0d7dbed1..a9c43c61 100644 --- a/man/orderly_metadata_extract.Rd +++ b/man/orderly_metadata_extract.Rd @@ -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: