Parameter Guidance¶
Most parameters can be left at their default values. The following sections provide guidance on key arguments that may be useful to adjust for specific applications.
Peak Calling Controls¶
matchingParams.peakModeSpecifies calling of narrow and/or broad marks.
narrowWrites UCSC narrowPeak calls.
broadWrites UCSC gappedPeak calls.
bothWrites narrow and broad calls.
matchingParams.selectionPenaltyMultiplierScales the data-derived per-bin selection penalty. The default is
1.0.Values below
1.0yield more relaxed selection. Values above1.0increase stringency.
matchingParams.gammaSets the penalty for boundaries between selected and unselected bins (default
0.25). Sometimes called the total variation penalty in signal and image processing literature.Larger values discourage fragmentation of selected regions, while smaller values allow more granular calls.
For instance, if calling TF ChIP-seq peaks for a punctate mark like Pol II, a
matchingParams.gamma: 0.05may be appropriate.
matchingParams.minMeanSignalKeeps candidate peaks whose mean signal reaches this threshold.
The default is
0.01. Disable withnull.
- (Advanced)
matchingParams.thresholdZ This parameter controls which regions are used to estimate the selection/budget penalty. Higher values restrict the estimation to more strongly enriched genomic regions. Note that this quantity need not change monotonically with respect to the final selection/budget penalty.
Lower values allow less enriched regions to influence budget/penalty calibration. The default is 2.0
Estimation Controls¶
countingParams.intervalSizeBPSets the genomic bin size in base pairs. Read and fragment inputs default to
50.Higher-resolution results may be obtained for deeply sequenced data using smaller
intervalSizeBP: 25 bp, 10 bp, etc. For detecting domain-level enriched-regions in broad marks like H3K27me3, larger values (100, 250, etc.) can be used. LargerintervalSizeBPis encouraged for shallow sequencing data.
observationParams.precisionMultiplierMinandobservationParams.precisionMultiplierMaxBound observation precision multipliers. The defaults are
0.1and10.0.
processParams.precisionMultiplierMinandprocessParams.precisionMultiplierMaxBound process precision multipliers. The defaults are
1.0e-4and10.0.Because \(Q_i=Q_0/\kappa_i\), the multipliers let the local frequency response adapt: smaller \(\kappa_i\) admits faster variation, whereas larger \(\kappa_i\) favors smoother variation.
outputParams.stateShrinkageEnabledEnables an experimental posterior state shrinkage using a spike-and-Student-\(t\) prior, with consenrich-estimated positional signal and uncertainty plugged-in.
Disable it in the YAML config w/
outputParams.stateShrinkageEnabled: false.Depending on the downstream application, the shrunk state/uncertainty tracks should be interpreted as approximate since the inputs are (fixed) estimates themselves, i.e., uncertainty is not propagated in the fully Bayesian sense.
Specifically, cutoffs on the shrunkState tracks (e.g., matchingParams.minMeanSignal for peaks) may become conservative relative to the original state.