Get overall statistics from GeneDiscoveR object

This function retrieves the overall statistics from a GeneDiscoveR object.

get_overall_statistics(GeneDiscoveRobject = NULL)

Arguments

GeneDiscoveRobject

A GeneDiscoveR object.

Value

A data frame containing the overall metrics from the GeneDiscoveR object.

See also

GeneDiscoveR calculate_overall_statistics plot_allSpeciesOGs_sOGs_per_inflation

Examples

# Create a GeneDiscoveR object
N0sDir <- system.file("extdata", "N0-1dot3-6", package = "GeneDiscoveR")
overallsDir <- system.file("extdata", "Comparatives-1dot3-6", package = "GeneDiscoveR")
dataFile <- system.file("extdata", "annotatedCDSs.tsv", package = "GeneDiscoveR")
minInflation <- 1.3
maxInflation <- 6
stepInflation <- 0.1

GeneDiscoveRobject <- GeneDiscoveR(overallsDir = overallsDir, N0sDir = N0sDir, dataFile = dataFile, minInflation = minInflation, maxInflation = maxInflation, stepInflation = stepInflation)

# Calculate overall statistics

GeneDiscoveRobject <- calculate_overall_statistics(GeneDiscoveRobject, cores = 8)

# Get overall statistics
overallStatistics <- get_overall_statistics(GeneDiscoveRobject)
# Output: A data frame containing the overall metrics from the GeneDiscoveR object.