Returns the canonical registry of all available report block types. Each entry defines the block's type, backing function, label, allowed parameters (with types and defaults), and required stats.
Details
Three optional fields steer the render loop in report_modular.Rmd:
requires_cols lists the data columns a block cannot render without,
compute_params names parameters that configure the auto-computation of
requires_stats but are not arguments of the backing function, and both
requires_stats and requires_cols may carry <param> placeholders that
resolve against the block's own parameters (so a block over
group_by = "biosample_name" requires that column and its own stats slot).
A parameter entry may carry required = TRUE. Those parameters have no
defensible default: either the backing function declares no default
(av_plot_locus(gene_name), av_plot_target(target_col)), or its default
is meaningless in report context (av_plot_target(target_value = TRUE)
against a gene column, av_plot_comparison(comparison_name = NULL), which
silently takes the first entry of $stats$comparisons and lands on the
Fisher enrichment entry, whose schema it cannot plot). Blocks with an
unset required parameter are rejected before rendering instead of aborting
the report mid-render.
Examples
reg <- av_report_registry()
names(reg)
#> [1] "section_header" "text_markdown"
#> [3] "summary_qc" "plot_ridges"
#> [5] "plot_ranking" "plot_ecdf"
#> [7] "plot_directionality" "plot_score_hybrid"
#> [9] "plot_volcano" "plot_enrichment_bar"
#> [11] "table_enrichment" "plot_interval"
#> [13] "plot_locus" "plot_annotation_region"
#> [15] "plot_annotation_tss" "plot_annotation_custom"
#> [17] "table_gene_impact" "plot_gene_vs_background"
#> [19] "plot_comparison" "plot_prioritization"
#> [21] "plot_target_vs_background" "plot_threshold_scan"
#> [23] "table_variant_data" "plot_specificity_tau"
#> [25] "plot_specificity_top_element" "table_targets"
#> [27] "gene_deep_dive"