population_fst
Differentiation between populations of a call set: Weir and Cockerham's θ over two or more populations, or Hudson's or Patterson's Fst between pairs, per site and averaged with a block-jackknife standard error (scikit-allel). Every pair when more than two populations are compared. Validated on every site of 1000 Genomes phase 3 APOL1 for the 5 super-populations and 26 populations.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vcf | Yes | the call set as VCF text (a .vcf, or a .vcf.gz already decompressed); every record's GT is read, ploidy 2. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| compare | No | the populations to compare, comma-separated; empty is every group of the column. | |
| groupBy | No | which column of the sample table groups the samples; empty is its first grouping column. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| estimator | No | weirCockerham: θ from the variance components over every compared population at once. hudson: 1 − within / between pairwise differences (Bhatia 2013). patterson: F2-based, biallelic sites only. Values: weirCockerham (Weir–Cockerham θ), hudson (Hudson Fst), patterson (Patterson Fst). | hudson |
| blockLength | No | sites per jackknife block for the average's standard error; a trailing partial block is dropped, as scikit-allel does. | |
| populations | Yes | a sample table: a header row with a `sample` column and one or more grouping columns (tab-separated, as 1000 Genomes' .panel). Samples it does not list belong to no group. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sites | Yes | per site: pos, and per comparison the site's Fst (numerator / denominator), null where undefined | |
| matrix | Yes | pairwise average Fst between every compared population (Hudson and Patterson) | |
| average | Yes | per comparison: the populations, Fst over all sites, its jackknife standard error, blocks |