plotSimilarity: Create a heatplot with similarities between all organisms

Description Usage Arguments Value Methods (by class) See Also Examples

Description

This method creates a heatplot showing the similarity between all organisms in the pangenome. The similarity can either be derived from the pangenome matrix or from kmer calculations of the genes themselves.

Usage

1
2
3
4
5
plotSimilarity(object, ...)

## S4 method for signature 'pgVirtual'
plotSimilarity(object, type = "pangenome",
  ordering = "auto", kmerSize, pParam, chunkSize = 100)

Arguments

object

A pgVirtual subclass

...

Parameters to be passed on.

type

The type of similarity calculation. Either 'pangenome' or 'kmer'

ordering

The ordering of rows and column in the heatmap. Either integer og character vector with organism names or one of the following: 'auto' or 'none'. For 'auto' The ordering will be based on a hierarchical clustering of the organisms based on Ward's distance.

kmerSize

The size of the kmers to use for comparison

pParam

An object of class BiocParallelParam

chunkSize

Number of organisms to process at a time

Value

This function is called for its side effects

Methods (by class)

  • pgVirtual: Similarity heatmaps for pgVirtual subclasses

See Also

plotTree for a dendrogram plot of the same data.

Examples

1
2
3
4
5
6
7
testPG <- .loadPgExample(withGroups=TRUE)

# Use kmers
plotSimilarity(testPG, type='kmer')

# Use pangenome matrix
plotSimilarity(testPG, type='pangenome')


Search within the FindMyFriends package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.