diff --git a/DESCRIPTION b/DESCRIPTION index 8c6d6c0a..ad89071f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: orderly2 Title: Orderly Next Generation -Version: 1.99.25 +Version: 1.99.26 Authors@R: c(person("Rich", "FitzJohn", role = c("aut", "cre"), email = "rich.fitzjohn@gmail.com"), person("Robert", "Ashton", role = "aut"), diff --git a/vignettes/metadata.Rmd b/vignettes/metadata.Rmd index 8af5f97c..f812f133 100644 --- a/vignettes/metadata.Rmd +++ b/vignettes/metadata.Rmd @@ -81,19 +81,19 @@ archive/ ## Configuration (`.outpack/config.json`) -The outpack configuration schema is defined in [`config.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/outpack/schema/config.json) +The outpack configuration schema is defined in [`config.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/schema/outpack/config.json) The configuration format is still subject to change... ## Packet metadata (`.outpack/metadata/`) -Each file within this directory has a filename that is an outpack id (matching the regular expression `^[0-9]{8}-[0-9]{6}-[0-9a-f]{8}$`, see below. Each file is a json file conforming to the schema [`metadata.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/outpack/schema/metadata.json). +Each file within this directory has a filename that is an outpack id (matching the regular expression `^[0-9]{8}-[0-9]{6}-[0-9a-f]{8}$`, see below. Each file is a json file conforming to the schema [`metadata.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/schema/outpack/metadata.json). Being present here means that an outpack implementation can report information back about a packet (when it was created, what files it contains, etc), but packet metadata are not very meaningful on their own; we want to know where they might have come from (a location that is distributing this packet) and if we have a copy of the packet locally. ## Location information (`.outpack/location/`) -This directory matches the regular expression `^[0-9]{8}$` (e.g., `457f4f2a`) and is a "location id" (see below) corresponding to a "location". Each file within this directory has an outpack id as name, and contains json about when that location unpacked (or installed) the packet, and the hash of the metadata. This file conforms to the schema [`location.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/outpack/schema/location.json). +This directory matches the regular expression `^[0-9]{8}$` (e.g., `457f4f2a`) and is a "location id" (see below) corresponding to a "location". Each file within this directory has an outpack id as name, and contains json about when that location unpacked (or installed) the packet, and the hash of the metadata. This file conforms to the schema [`location.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/schema/outpack/location.json). ## A file store (`.outpack/files`) @@ -137,7 +137,7 @@ For your local location id, write out a file .outpack// ``` -conforming to the [`location.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/outpack/schema/location.json) schema, and containing the packet id, the time that it was marked as unpacked and the hash of the metadata. +conforming to the [`location.json`](https://github.com/mrc-ide/orderly2/blob/main/inst/schema/outpack/location.json) schema, and containing the packet id, the time that it was marked as unpacked and the hash of the metadata. ## Ordering of operations