orderly_description

Distributed reproducible computing framework, adopting
ideas from git, docker and other software.  By defining a
lightweight interface around the inputs and outputs of an
analysis, a lot of the repetitive work for reproducible research
can be automated.  We define a simple format for organising and
describing work that facilitates collaborative reproducible
research and acknowledges that all analyses are run multiple times
over their lifespans.

Rich FitzJohn

orderly

Lightweight Reproducible Reporting

Robert Ashton

Martin Eden

Alex Hill

Wes Hinsley

Mantra Kusumgar

Paul Liétar

James Thompson

Katy Gaythorpe

Imperial College of Science, Technology and Medicine 

orderly_description function

<dl><dt>display</dt>
<dd>A friendly name for the report; this will be
displayed in some locations of the web interface, packit. If
given, it must be a scalar character.</dd>
<dt>long</dt>
<dd>A longer description of the report. If given,
it must be a scalar character.</dd>
<dt>custom</dt>
<dd>Any additional metadata. If given, it must be a named
list, with all elements being scalar atomics (character, number,
logical).</dd></dl>

Arguments

Describe the current packet — orderly_description

<dl>

<dt>display</dt>
<dd>A friendly name for the report; this will be
displayed in some locations of the web interface, packit. If
given, it must be a scalar character.</dd>


<dt>long</dt>
<dd>A longer description of the report. If given,
it must be a scalar character.</dd>


<dt>custom</dt>
<dd>Any additional metadata. If given, it must be a named
list, with all elements being scalar atomics (character, number,
logical).</dd>

</dl>

Describe the current packet

orderly_description: Describe the current packet

Description

Usage

Value

Arguments

Examples