Redocument

mrc-ide · Oct 22, 2024 · 2e6e751 · 2e6e751
1 parent 535390f
commit 2e6e751
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git 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