Basic use

Core orderly functions for basic use

orderly_init()

Initialise an orderly store

orderly_new()

Create new report

orderly_run()

Run a report

orderly_commit()

Commit a generated report

Develop a report

Interactively develop an orderly report by copying its requiremnts into the source directory

orderly_develop_start() orderly_develop_status() orderly_develop_clean()

Develop an orderly report

Query existing reports

Find information about previous run reports (draft, archive or failed), search for versions and show information about the dependency graph

orderly_graph()

Print the dependency tree for a given report using orderly log

orderly_graph_out_of_date()

Given a tree return a list of reports to be re-run (and the order that they should be re-run)

orderly_info()

Return info about a report which has been run

orderly_latest()

Find most recent report

orderly_list()

List orderly reports

orderly_list_drafts() orderly_list_archive()

List draft and archived reports

orderly_list_metadata()

List reports with only local metadata

orderly_search()

Search for orderly reports matching criteria

Helpers

A group of usethis-inspired functions for editing orderly.yml and configuring a report

orderly_use_resource() orderly_use_source() orderly_use_package() orderly_use_gitignore()

Add a resource to orderly.yml

Remotes

Interact with remotes (see also vignettes("remotes"))

orderly_pull_dependencies() orderly_pull_archive() orderly_push_archive()

Download dependent reports

orderly_remote_path()

Orderly remote at a different path

orderly_remote_status()

Get status of remote queue.

orderly_default_remote_set() orderly_default_remote_get()

Set default remote location

orderly_run_remote()

Run a report on a remote server

Advanced - bundles

Bundle orderly reports to run on another machine (see also vignettes("bundles"))

orderly_bundle_pack() orderly_bundle_run() orderly_bundle_import() orderly_bundle_list()

Pack and run orderly "bundles"

orderly_bundle_pack_remote() orderly_bundle_import_remote()

Pack and import bundles with remotes

Advanced - access orderly's state

Functions that allow interacting with orderly’s internal state. Typical users will not need to interact with these very often

orderly_config()

Retrieve orderly config object.

orderly_db()

Connect to orderly databases

orderly_remote()

Get a remote

Advanced - maintenance

Functions for maintenance of orderly’s archive. You may be pointed to these by error messages.

orderly_cleanup()

Orderly cleanup

orderly_deduplicate()

Deduplicate an orderly archive

orderly_rebuild()

Rebuild the report database

orderly_migrate()

Migrate an orderly archive

Other

Functions that do not fit neatly into the above groupings.

orderly_example()

Set up an orderly example

orderly_run_info()

Information on current orderly run

orderly_log_on() orderly_log_off() orderly_log()

Orderly logging and diagnostic messages

orderly_batch()

Run a batch of reports.

orderly_test_start() orderly_test_check()

Prepare a directory for orderly to use