| identifySTRRegions.control {STRMPS} | R Documentation |
Control function for identifySTRRegions
Description
A list containing default parameters passed to the identifySTRRegions function.
Usage
identifySTRRegions.control(colList = NULL, numberOfThreads = 4L,
reversed = TRUE, includeReverseComplement = TRUE, combineLists = TRUE,
removeEmptyMarkers = TRUE, matchPatternMethod = "mclapply")
Arguments
colList |
The position of the forward, reverse, and motifLength columns in the flanking region tibble/data.frame. If 'NULL' a function searches for the words 'forward', 'reverse', and 'motif' ot identify the columns. |
numberOfThreads |
The number of threads used by mclapply (stuck at '2' on windows). |
reversed |
TRUE/FALSE: In a revrse complementary run, should the strings/quality be reversed (recommended)? |
includeReverseComplement |
TRUE/FALSE: Should the function also search for the reverse complement DNA strand (recommended)? |
combineLists |
TRUE/FALSE: If 'includeReverseComplement' is TRUE, should the sets be combined? |
removeEmptyMarkers |
TRUE/FALSE: Should markers returning no identified regions be removed? |
matchPatternMethod |
Which method should be used to identify the flanking regions (only 'mclapply' implemented at the moment)? |
Value
A control list setting default behaviour.