MAIDR Documentation - v4.4.0
    Preparing search index...

    Interface VolcanoPointConfig

    Configuration for volcano and Manhattan plots. Optional when chartType is 'volcano' or 'manhattan'.

    None of this is inferable from a Recharts <Scatter>: the component holds coordinates, and these charts are read for identity and for which side of a cutoff a point falls on. Both arrive from the author or not at all.

    interface VolcanoPointConfig {
        labelKey?: string;
        groupKey?: string;
        significance?: number;
        significanceDirection?: "above" | "below";
        effect?: number;
    }
    Index

    Properties

    labelKey? groupKey? significance? significanceDirection? effect?

    Properties

    labelKey?: string

    Key holding what the point is — a gene, a SNP, a probe.

    groupKey?: string

    Key holding the region the point belongs to — a chromosome.

    significance?: number

    The significance cutoff on the y axis.

    There is no default: -log10(p) puts the line at 1.3 for p < 0.05 and at 7.3 for genome-wide significance, and a guessed line sorts every point onto the wrong side silently.

    significanceDirection?: "above" | "below"

    Which side of the cutoff is the significant one. Defaults to 'above', which is right for the transformed axes these charts usually carry. A raw p axis runs the other way and must declare 'below'.

    effect?: number

    The effect-size cutoff, applied to the magnitude of x.

    Settings

    Member Visibility

    On This Page

    Properties