HC: A Reference Class for managing a HybridCheck analysis.

Description Fields Methods

Description

A Reference Class for managing a HybridCheck analysis.

Fields

DNA

A HCdna reference object.

FTTmodule

A FTTester object, controls and stores results of the Four Taxon Tests.

comparrisonSettings

A ComparrisonSettings object.

ssAnalysisSettings

A SSAnalysisSettings object.

blockDetectionSettings

A BlockDetectionSettings object.

blockDatingSettings

A BlockDatingSettings object.

plottingSettings

A PlottingSettings object.

triplets

A Triplets object.

userBlocks

A UserBlocks object.

filesDirectory

Character - the root directory where all temporary files used by this object are found.

Methods

analyzeSS(tripletSelections = "NOT.SCANNED", replaceSettings = FALSE, ...)

Analyzing the sequence similarity of triplets of sequences. tripletSelections can be 'NOT.SCANNED', 'ALL', 'SCANNED', or a list of character vectors of length 3, each specifying a sequence triplet by the names of the sequences involved. If replaceSettings is TRUE, then optional settings passed for this analysis will apply to subsequent calls of this function.

initialize(dnafile = NULL)

Create HC object with default values for fields. The path to the FASTA file can be provided.

inputDNA(input)

Loads FASTA file or Biostrings object into the session.

prepareFourTaxonTests(taxa = NULL)

Prepares space for four taxon tests.

runFourTaxonTests(selections = "NOT.TESTED", numberOfBlocks = NULL, blockLength = NULL)

Runs the four taxon tests that have been prepared. You must provide either a number of blocks to use for the jackknife, or the size of the blocks to use for the jackknife, the exact size and number of blocks to use is then automatically worked out. selections can be 'NOT.TESTED', 'ALL', 'TESTED', or a list of character vectors of length 4, each denoting a four taxon test by the names of the populations involved.

sequenceNames()

Returns a character vector of all the sequence names loaded.

sequencesLoaded()

Returns TRUE if dna sequences have been loaded.

setParameters(Step = NULL, ...)

Set parameters for a single stage of the analysis. Specify a single stage for Step. The steps are: 'FTT', 'TripletGeneration', 'SSAnalysis', 'BlockDetection', 'BlockDating', 'Plotting'.

setPopulations(pops = NULL)

Sets up population definitions. If pops is NULL, each sequence loaded is assumed to be from one population.

showParameters(Step = NULL)

Displays to the R console, the settings of each HC analysis stage.

tabulateFourTaxonTests(selections = "ALL", neat = TRUE, global = TRUE)

Fetches the results of the four taxon tests, returns a dataframe. selections can be 'ALL', 'TESTED', or a list of character vectors of length 4, each denoting a four taxon test by the names of the populations involved.


Ward9250/HybridCheck documentation built on June 5, 2020, 12:39 a.m.