ras_sumstats_report: Inspect an External-Summary Alignment Without Committing to...

View source: R/sumstats.R

ras_sumstats_reportR Documentation

Inspect an External-Summary Alignment Without Committing to It

Description

A non-fatal report on how an external summary-statistics file lines up with a local genotype map: which ID convention each side uses, the suggested route, how many variants overlap by ID, what the build gate would say, and how the overlap is distributed along the chromosome. Run this before ras_harmonize_sumstats to see what the gates will do without triggering them.

Usage

ras_sumstats_report(ss, map, cols = list(), block_size = 500L)

Arguments

ss

Data frame of summary statistics, or a path to one.

map

The local genotype map (SNP, and CHR/BP for the build and coverage lines).

cols

Optional column-name overrides.

block_size

Integer. Window, in variants, for the coverage profile.

Details

The coverage line matters more here than in a PRS setting: RAS's statistic is regional, so weights that are missing in one stretch of the chromosome remove the scan's ability to detect there, rather than merely weakening it overall.

Value

Invisibly, a list with plan, n_id, build and blocks. Called for the report it prints.

See Also

ras_harmonize_sumstats


RAS documentation built on Nov. 3, 2026, 1:07 a.m.