API for orderly
Lightweight Reproducible Reporting

Global functions
`%||%` Source code
add_file_store Source code
as_orderly_query Source code
as_strict_list Source code
assert_character Source code
assert_directory_does_not_exist Source code
assert_file_exists Source code
assert_file_exists_relative Source code
assert_integer Source code
assert_is Source code
assert_is_directory Source code
assert_length Source code
assert_list Source code
assert_logical Source code
assert_named Source code
assert_nonmissing Source code
assert_not_orderly1_project Source code
assert_numeric Source code
assert_raw Source code
assert_relative_path Source code
assert_scalar Source code
assert_scalar_character Source code
assert_scalar_integer Source code
assert_scalar_logical Source code
assert_scalar_numeric Source code
assert_scalar_positive_integer Source code
assert_scalar_positive_numeric Source code
assert_scalar_size Source code
assert_simple_scalar_atomic Source code
build_packet_uses Source code
build_search_options Source code
check_current_packet Source code
check_device_stack Source code
check_fields Source code
check_files_relaxed Source code
check_files_strict Source code
check_parameter_values Source code
check_parameters Source code
check_parameters_interactive Source code
check_plugin_enabled Source code
check_produced_artefacts Source code
check_session_global_state Source code
check_sink_stack Source code
check_symbol_from_str Source code
clean_path Source code
cli_alert_info Source code
cli_alert_success Source code
cli_alert_warning Source code
cli_progress_bar Source code
cli_progress_update Source code
collapse Source code
collapseq Source code
collector Source code
compare_attribute Source code
compare_attribute_list Source code
compare_file_contents Source code
compare_files Source code
compare_filesets Source code
compatibility_fix_options Source code
config_new Source code
config_read Source code
config_serialise Source code
config_set_path_archive Source code
config_set_require_complete_tree Source code
config_set_use_file_store Source code
config_update Source code
config_write Source code
copy_files Source code
copy_files_from_remote Source code
copy_resources_implicit Source code
copy_shared_resource Source code
current_orderly_parameters Source code
current_orderly_version Source code
custom_metadata Source code
custom_metadata_deserialise Source code
data_frame Source code
delete_empty_directories Source code
deparse_brackets Source code
deparse_infix Source code
deparse_prefix Source code
deparse_query Source code
deparse_regular_function Source code
deparse_single Source code
deprecate_warn Source code
detect_orderly_interactive_path Source code
dir_ls_local Source code
do_orderly_gitignore_update Source code
dquote Source code
drop_local_packet Source code
drop_null Source code
empty_config_contents Source code
empty_time Source code
ensure_jsonvalidate Source code
error_both_configurations Source code
error_examples Source code
error_near_match Source code
expand_dirs Source code
expand_dirs_virtual Source code
expr_is_literal_id Source code
extract_convert Source code
extract_type Source code
file_canonical_case Source code
file_exists Source code Source code
file_export Source code
file_import_archive Source code
file_import_store Source code
fill_missing_names Source code
find_all_dependencies Source code
find_calling_env Source code
find_entrypoint_filename Source code
find_file_by_hash Source code
find_file_descend Source code
format.orderly_comparison Source code
format.orderly_query Source code
format_file_list Source code
get_active_packet Source code
get_metadata_hash Source code
get_missing_parameters_interactive Source code
get_parameter_interactive Source code
get_type Source code
git_info Source code
git_open Source code
gitignore_content_root Source code
gitignore_content_src Source code
gitignore_update_contents Source code
gitignore_update_file Source code
graph_edges_to_df Source code
graph_packets_from Source code
graph_packets_to Source code
hash_data Source code
hash_file Source code
hash_files Source code
hash_parse Source code
hash_validate Source code
hash_validate_data Source code
hash_validate_file Source code
http_body_json Source code
http_client_error Source code
http_client_handle_error Source code
http_client_request Source code
ignore_errors Source code
index_update Source code
is_assignment Source code
is_binary_file Source code
is_call Source code
is_deparseable_query Source code
is_dev_package Source code
is_directory Source code
is_library_orderly2 Source code
is_orderly_ns_call Source code
is_plausible_orderly_report Source code
is_simple_atomic Source code
is_simple_scalar_atomic Source code
is_string Source code
is_testing Source code
is_valid_test Source code
iso_time_str Source code
last Source code
list_to_character Source code
list_to_numeric Source code
load_namespace Source code
load_orderly2_support Source code
load_orderly_plugin Source code
load_schema Source code
location_build_pull_plan Source code
location_build_pull_plan_files Source code
location_build_pull_plan_location Source code
location_build_pull_plan_packets Source code
location_build_push_plan Source code
location_check_exists Source code
location_check_new_name Source code
location_driver Source code
location_driver_create Source code
location_exists Source code
location_fetch_metadata Source code
location_file_pull_meta Source code
location_path_import_file Source code
location_path_import_metadata Source code
location_pull_files Source code
location_pull_files_archive Source code
location_pull_hash_store Source code
location_push_files Source code
location_push_metadata Source code
location_resolve_valid Source code
mark_packet_known Source code
mark_packets_orphaned Source code
match_value Source code
migrate_1_99_82 Source code
migrate_1_99_82_file Source code
migrate_1_99_88 Source code
migrate_1_99_90 Source code
migrate_check_archive_status Source code
migrate_check_git_status Source code
migrations Source code
near_match Source code
near_matches Source code
new_location_entry Source code
new_query_index Source code
normalise_path Source code
num_to_time Source code
orderly-deprecated Man page
orderly2_compat_enabled Source code
orderly_artefact Man page Source code
orderly_cleanup Man page Source code
orderly_cleanup_status Man page Source code
orderly_compare_packets Man page Source code
orderly_comparison_explain Man page Source code
orderly_config Man page Source code
orderly_config_read Source code
orderly_config_set Man page Source code
orderly_config_validate_minimum_orderly_version Source code
orderly_config_validate_plugins Source code
orderly_context Source code
orderly_copy_files Man page Source code
orderly_dependency Man page Source code
orderly_description Man page Source code
orderly_envir_read Source code
orderly_example Man page Source code
orderly_example_path Source code
orderly_example_show Man page Source code
orderly_file Source code
orderly_find_root Source code
orderly_find_root_here Source code
orderly_find_root_locate Source code
orderly_gitignore_update Man page Source code
orderly_graph_packets Source code
orderly_hash_data Man page Source code
orderly_hash_file Man page Source code
orderly_init Man page Source code
orderly_interactive_set_search_options Man page Source code
orderly_list_src Man page Source code
orderly_location_add Man page Source code
orderly_location_add_http Man page Source code
orderly_location_add_packit Man page Source code
orderly_location_add_path Man page Source code
orderly_location_custom Source code
orderly_location_fetch_metadata Man page Source code
orderly_location_list Man page Source code
orderly_location_packit Source code
orderly_location_pull Man page Source code
orderly_location_pull_metadata Man page Source code
orderly_location_pull_packet Man page Source code
orderly_location_push Man page Source code
orderly_location_remove Man page Source code
orderly_location_rename Man page Source code
orderly_metadata Man page Source code
orderly_metadata_extract Man page Source code
orderly_metadata_read Man page Source code
orderly_migrate_read_version Source code
orderly_migrate_source Man page Source code
orderly_new Man page Source code
orderly_packet_add_metadata Source code
orderly_packet_cleanup_failure Source code
orderly_packet_cleanup_success Source code
orderly_parameters Man page Source code
orderly_parse_expr Man page Source code
orderly_parse_file Man page Source code
orderly_plugin Source code
orderly_plugin_add_metadata Man page Source code
orderly_plugin_context Man page Source code
orderly_plugin_register Man page Source code
orderly_prune_orphans Man page Source code
orderly_query Man page Source code
orderly_query_eval Source code
orderly_query_explain Man page Source code
orderly_query_format Source code
orderly_quiet Source code
orderly_read Source code
orderly_read_expr Source code
orderly_resource Man page Source code
orderly_run Man page Source code
orderly_run_info Man page Source code
orderly_search Man page Source code
orderly_search_options Man page Source code
orderly_session_info Source code
orderly_shared_resource Man page Source code
orderly_src_root Source code
orderly_strict_mode Man page Source code
orderly_validate Source code
orderly_validate_archive Man page Source code
orderly_validate_archive_packet Source code
orderly_validate_archive_packet_check Source code
outpack_checksum Source code
outpack_id Source code
outpack_insert_packet Source code
outpack_metadata_core Source code
outpack_metadata_core_deserialise Source code
outpack_metadata_core_load Source code
outpack_metadata_create Source code
outpack_metadata_load Source code
outpack_packet_add_custom Source code
outpack_packet_cancel Source code
outpack_packet_end Source code
outpack_packet_file_list Source code
outpack_packet_file_mark Source code
outpack_packet_finish Source code
outpack_packet_start Source code
outpack_packet_use_dependency Source code
outpack_schema_version Source code
packit_authentication Source code
pairs Source code
parse_extract Source code
parse_json Source code
path_is_git_ignored Source code
paths_are_identical Source code
pkg_root Source code
plan_copy_files Source code
plugin_no_cleanup Source code
plugin_no_deserialise Source code
plugin_no_serialise Source code
plugin_run_cleanup Source code
pretty_bytes Source code
prevent_multiple_calls Source code
print.orderly_cleanup_status Source code
print.orderly_comparison Source code
print.orderly_query Source code
print.orderly_query_explain Source code
prompt_parameters_interactive Source code
query_eval Source code
query_eval_dependency Source code
query_eval_empty Source code
query_eval_group Source code
query_eval_latest Source code
query_eval_lookup Source code
query_eval_lookup_environment Source code
query_eval_lookup_get Source code
query_eval_lookup_parameter Source code
query_eval_single Source code
query_eval_subquery Source code
query_eval_test Source code
query_eval_test_binary Source code
query_parse Source code
query_simplify Source code
query_unhandled_error Source code
quote_braces Source code
read_config_data Source code
read_file_lossy Source code
read_json Source code
read_lines Source code
read_location Source code
read_locations Source code
read_metadata Source code
read_string Source code
rehash Source code
remove_file_store Source code
rep_along Source code
replace_ragged Source code
resolve_envvar Source code
root_check_git Source code
root_list_unknown_files Source code
root_list_unknown_packets Source code
root_open Source code
root_validate_same_configuration Source code
row_any Source code
rstudio_get_current_active_editor_path Source code
saverds_atomic Source code
scalar Source code
session_global_state Source code
set_class Source code
set_names Source code
should_validate_schema Source code
show_file Source code
source_echo Source code
squote Source code
static_character_vector Source code
static_eval Source code
static_orderly_artefact Source code
static_orderly_dependency Source code
static_orderly_description Source code
static_orderly_parameters Source code
static_orderly_resource Source code
static_orderly_shared_resource Source code
static_orderly_strict_mode Source code
static_string Source code
storage_mode_scalar Source code
strict_list Source code
string_drop_prefix Source code
string_interpolate_simple Source code
string_interpolate_simple1 Source code
string_starts_with Source code
sys_getenv Source code
system_file Source code
temporary_filestore Source code
time_to_num Source code
to_json Source code
unload_orderly2_support Source code
update_minimum_orderly_version Source code
update_minimum_orderly_version_json Source code
update_minimum_orderly_version_yml Source code
url_append Source code
val_to_bytes Source code
validate_file_from_to Source code
validate_hashes Source code
validate_orderly_directory Source code
validate_outpack_id Source code
validate_packet_has_file Source code
validate_parameters Source code
vcapply Source code
vectorized_identical Source code
vlapply Source code
vnapply Source code
with_trailing_slash Source code
yaml_load Source code
yaml_read Source code
orderly documentation built on Jan. 24, 2026, 1:07 a.m.