Skip to content

Commit

Permalink
Merge pull request #164 from zkamvar/znk/fix-broken-github-urls
Browse files Browse the repository at this point in the history
fix broken github URLs
  • Loading branch information
richfitz authored Aug 14, 2024
2 parents 534c743 + 432dc8e commit 762d0ab
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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 = "[email protected]"),
person("Robert", "Ashton", role = "aut"),
Expand Down
8 changes: 4 additions & 4 deletions vignettes/metadata.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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`)

Expand Down Expand Up @@ -137,7 +137,7 @@ For your local location id, write out a file
.outpack/<local location id>/<packet id>
```

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

Expand Down

0 comments on commit 762d0ab

Please sign in to comment.