Package index • orderly2

Run a report

orderly_run(): Run a report

orderly_list_src(): List source reports

From within a running report

These are the functions that get called from your orderly file

orderly_strict_mode(): Enable orderly strict mode

orderly_parameters(): Declare orderly parameters

orderly_description(): Describe the current packet

orderly_resource(): Declare orderly resources

orderly_shared_resource(): Copy shared resources into a packet directory

orderly_dependency(): Declare a dependency

orderly_artefact(): Declare orderly artefacts

orderly_run_info(): Information about currently running report

Read packet metadata

orderly_metadata(): Read outpack metadata

orderly_metadata_read(): Read outpack metadata json file

orderly_metadata_extract(): Extract metadata from orderly2 packets

Search

orderly_query(): Construct outpack query

orderly_search_options(): Packet search options

orderly_search(): Query outpack's database

orderly_query_explain(): Explain a query

Initialise and configure

orderly_init(): Initialise an orderly repository

orderly_config(): Read configuration

orderly_config_set(): Set configuration options

Interact with locations

Use locations

orderly_location_pull_metadata(): Pull metadata from a location

orderly_location_pull_packet(): Pull one or more packets from a location

orderly_location_push(): Push tree to location

Manage locations

orderly_location_add(): Add a new location

orderly_location_list(): List known pack locations

orderly_location_remove(): Remove a location

orderly_location_rename(): Rename a location

Help for developing

orderly_new(): Create a new report

orderly_cleanup() orderly_cleanup_status(): Clean up source directory

orderly_gitignore_update(): Update a gitignore file

orderly_interactive_set_search_options(): Set search options for interactive use

Create plugins

orderly_plugin_add_metadata(): Add metadata from plugin

orderly_plugin_context(): Fetch plugin context

orderly_plugin_register(): Register an orderly plugin

Everything else

orderly_copy_files(): Copy files from a packet

orderly_example(): Copy a simple orderly example

orderly_prune_orphans(): Prune orphan packet metadata

orderly_validate_archive(): Validate unpacked packets.

orderly_hash_file() orderly_hash_data(): Compute a hash

orderly_parse_file() orderly_parse_expr(): Parse the orderly entrypoint script