Skip to contents

Claims register

Read, summarise and check claims.yml.

read_claims()
Read the claims register
find_claims()
Locate the claims register
claims_summary()
Count claims by verdict
scoreboard()
Format the register as plain text
check_claims()
Fail if any claim has regressed

Rendering the register

Markdown and HTML for the README, the home page and the evidence articles.

claims_list_md()
Render the register as a numbered list
scoreboard_md()
Render the register as a markdown table
claim_sections_md()
Render one evidence-article section per claim
badges_md()
Render the README badge row
verdict_html()
Format verdicts as HTML spans
evidence_page()
Evidence article for each parasite
md_cell()
Escape text for a markdown table cell
replace_block()
Replace the text between marker comments

Comparison statistics

Every statistic quoted in the evidence, defined once and unit-tested.

agreement()
Agreement between two models on the same quantity
BAND_K BURDEN_MIN
Replicate band width and burden floor
replicate_band()
Replicate band for one cell
band_z()
Standardised departure from a set of replicates
outside_rates()
Out-of-band rates for a candidate and for held-out replicates
band_position() inside_band()
Position of a value relative to a band
band_summary()
Summarise a set of band comparisons

Provenance and paths

stamp()
Record what produced a result
round_sig()
Round the numeric columns of a data frame
fc_root()
Locate the fleetcheck checkout
fc_results()
Path to a validation's results directory

Scenario constants

Settings shared by the comparison scripts. Exported so the scripts also run against an installed package, not only under pkgload::load_all().