orderly2.0.0 package

Lightweight Reproducible Reporting

orderly_config

Read configuration

orderly_copy_files

Copy files from a packet

orderly_dependency

Declare a dependency

orderly_description

Describe the current packet

orderly_example_show

Show an example file

orderly_example

Copy a simple orderly example

orderly_gitignore_update

Update a gitignore file

orderly_hash

Compute a hash

orderly_init

Initialise an orderly repository

orderly_interactive_set_search_options

Set search options for interactive use

orderly_list_src

List source reports

orderly_location_add

Add a new location

orderly_location_fetch_metadata

Fetch metadata from a location

orderly_location_list

List known pack locations

orderly_location_pull

Pull one or more packets from a location

orderly_location_push

Push tree to location

orderly_location_remove

Remove a location

orderly_location_rename

Rename a location

orderly_metadata_extract

Extract metadata from orderly packets

orderly_metadata_read

Read outpack metadata json file

orderly_metadata

Read outpack metadata

orderly_migrate_source

Migrate orderly source code

orderly_new

Create a new report

orderly_parameters

Declare orderly parameters

orderly_parse_file

Parse the orderly entrypoint script

orderly_plugin_add_metadata

Add metadata from plugin

orderly_plugin_context

Fetch plugin context

orderly_plugin_register

Register an orderly plugin

orderly_prune_orphans

Prune orphan packet metadata

orderly_artefact

Declare orderly artefacts

orderly_cleanup

Clean up source directory

orderly_compare_packets

Compare the metadata and contents of two packets.

orderly_comparison_explain

Print the details of a packet comparison.

orderly_config_set

Set configuration options

orderly_query_explain

Explain a query

orderly_query

Construct outpack query

orderly_resource

Declare orderly resources

orderly_run_info

Information about currently running report

orderly_run

Run a report

orderly_search_options

Packet search options

orderly_search

Query orderly's database

orderly_shared_resource

Copy shared resources into a packet directory

orderly_strict_mode

Enable orderly strict mode

orderly_validate_archive

Validate unpacked packets.

orderly-deprecated

Deprecated functions in orderly. These functions still work (**for now...

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.

  • Maintainer: Rich FitzJohn
  • License: MIT + file LICENSE
  • Last published: 2025-10-09