Skip to contents

Looks up a one-paragraph + short-table explanation by filename (any leading directory components are stripped). Falls back to matching on the filename stem if the extension differs.

Usage

explain_file(filename)

Arguments

filename

The CSV filename, with or without a path.

Value

A character scalar containing the explanation. If no registered entry matches, returns a fallback listing the known files.

Examples

cat(explain_file("power_summary.csv"))
#> Question this file answers: "What were the design assumptions for my
#> power analysis, and what's the recommended sample size at a glance?"
#> 
#> It's a one-row summary.  Read across; columns include:
#>   - effect_size          The minimum effect you said you want to detect
#>   - alpha                False-positive rate (typically 0.05)
#>   - power                True-positive rate (typically 0.80)
#>   - n_recommended        Per-group sample size to hit (power, effect) at alpha
#> 
#> If you want detail beyond the summary row, see the companion files
#> listed in `power_two_proportion_gender.csv` (two-proportion grid) and
#> `power_one_proportion_grid.csv` (one-proportion grid).