Returns the API classification registry for all exported bg_* functions.
Each function is classified as stable, experimental, internal, or
deprecated.
Value
A data.frame with columns:
- fn
Function name (character)
- classification
One of
stable,experimental,internal, ordeprecated
Details
Classification meanings
stable: Core public API expected to remain backward-compatible. Includes project lifecycle, graph editing, branching, decisions, execution control, status/results, and established workflow entry points.experimental: Newer or provisional APIs that may evolve. Includes workflow protocol, context and template APIs, the REPL, and convenience functions for fitting models.internal: Exported for use by workers or other processes. Not intended for direct use in analyses. Includes artifact helpers, job primitives, and backend registration.deprecated: Kept temporarily for backward compatibility and warns on use.
Examples
# Get all API boundary entries
bg_api_boundary()
#> fn classification
#> 19 bg_add_gate stable
#> 7 bg_add_node stable
#> 20 bg_answer_gate stable
#> 76 bg_api_boundary stable
#> 13 bg_branch stable
#> 14 bg_branch_lineage stable
#> 54 bg_build_workflow_context experimental
#> 51 bg_bundle stable
#> 4 bg_close stable
#> 34 bg_compact_jobs experimental
#> 49 bg_compute_fingerprint stable
#> 8 bg_connect stable
#> 26 bg_execute_action experimental
#> 52 bg_export_report stable
#> 25 bg_extension_registry experimental
#> 37 bg_fit_brms experimental
#> 36 bg_fit_stan experimental
#> 47 bg_get_goal stable
#> 38 bg_graph_mermaid stable
#> 1 bg_handle stable
#> 75 bg_hmc_severity stable
#> 2 bg_init stable
#> 18 bg_invalidate stable
#> 33 bg_jobs stable
#> 15 bg_list_branches stable
#> 69 bg_list_templates experimental
#> 55 bg_next_actions stable
#> 35 bg_node_pad experimental
#> 3 bg_open stable
#> 56 bg_partition_protocol_by_scope experimental
#> 29 bg_pause experimental
#> 21 bg_pending_gates stable
#> 27 bg_plan stable
#> 39 bg_plot experimental
#> 40 bg_read_branch_registry stable
#> 24 bg_read_decisions stable
#> 41 bg_read_goal_registry stable
#> 12 bg_read_graph stable
#> 42 bg_read_summaries stable
#> 23 bg_record_decision stable
#> 71 bg_register_node_kind internal
#> 66 bg_register_rule_predicate experimental
#> 64 bg_register_ruleset experimental
#> 45 bg_register_summary_kind experimental
#> 11 bg_remove_node stable
#> 22 bg_repair_orphan_gates experimental
#> 70 bg_repl experimental
#> 60 bg_research_apply experimental
#> 57 bg_research_init experimental
#> 59 bg_research_propose experimental
#> 58 bg_research_state experimental
#> 72 bg_restore_executors experimental
#> 32 bg_result stable
#> 30 bg_resume experimental
#> 17 bg_retire_branch stable
#> 16 bg_retire_node stable
#> 61 bg_rule experimental
#> 68 bg_rules experimental
#> 62 bg_ruleset experimental
#> 63 bg_ruleset_check experimental
#> 65 bg_rulesets experimental
#> 28 bg_run stable
#> 48 bg_scope_label stable
#> 46 bg_set_goal stable
#> 10 bg_set_node_data experimental
#> 50 bg_snapshot stable
#> 31 bg_status stable
#> 44 bg_summary_vocabulary experimental
#> 9 bg_update_node stable
#> 74 bg_use_brms stable
#> 73 bg_use_cmdstanr stable
#> 5 bg_use_default_workflow stable
#> 67 bg_use_rules experimental
#> 6 bg_use_workflow_packs stable
#> 53 bg_workflow_packs experimental
#> 43 bg_write_summaries stable
# Filter to a specific function
bg_api_boundary("bg_run")
#> fn classification
#> 28 bg_run stable
# Filter to experimental functions
subset(bg_api_boundary(), classification == "experimental")
#> fn classification
#> 54 bg_build_workflow_context experimental
#> 34 bg_compact_jobs experimental
#> 26 bg_execute_action experimental
#> 25 bg_extension_registry experimental
#> 37 bg_fit_brms experimental
#> 36 bg_fit_stan experimental
#> 69 bg_list_templates experimental
#> 35 bg_node_pad experimental
#> 56 bg_partition_protocol_by_scope experimental
#> 29 bg_pause experimental
#> 39 bg_plot experimental
#> 66 bg_register_rule_predicate experimental
#> 64 bg_register_ruleset experimental
#> 45 bg_register_summary_kind experimental
#> 22 bg_repair_orphan_gates experimental
#> 70 bg_repl experimental
#> 60 bg_research_apply experimental
#> 57 bg_research_init experimental
#> 59 bg_research_propose experimental
#> 58 bg_research_state experimental
#> 72 bg_restore_executors experimental
#> 30 bg_resume experimental
#> 61 bg_rule experimental
#> 68 bg_rules experimental
#> 62 bg_ruleset experimental
#> 63 bg_ruleset_check experimental
#> 65 bg_rulesets experimental
#> 10 bg_set_node_data experimental
#> 44 bg_summary_vocabulary experimental
#> 67 bg_use_rules experimental
#> 53 bg_workflow_packs experimental