shannon_conservativity: Calculate Shannon conservation metric

Description Usage Arguments Value Note Author(s) See Also Examples

Description

This function facilitates the calculation of Shannon conservation metric.

Usage

1

Arguments

alignment

Alignment data read with read.alignment function

weights

(optional) A vector of length equal number of sequences in the alignment object with weights to overcome the taxonomic bias in the conservation analysis.

pseudo_counts

(optional) A logical indicating if pseudo-counts should be added to the MSA. Pseudo-counts can be used only withouth weights. Using these option with pseudo-counts will be suppressed. Default: FALSE

Value

conservation_score

A vector of length equal to the length of aligned sequences

Note

Please note that the Shannon matric formula can be found in the paper listed in "See Also" section below. Also, this function originally calculates the entropy values which can be used to estimate the conservativity score according to the following formula:

conservation = 1 - entropy

Author(s)

Alicja Plucennik & Michal Stolarczyk

See Also

http://onlinelibrary.wiley.com/doi/10.1002/prot.10146/abstract

Examples

1
2
data("small_alignment")
conservation_score = shannon_conservativity(alignment)

Example output

Loading required package: seqinr
Loading required package: Rpdb
Loading required package: rgl

Attaching package: 'Rpdb'

The following objects are masked from 'package:base':

    norm, replicate, unsplit

Loading required package: scales

Attaching package: 'BALCONY'

The following object is masked from 'package:seqinr':

    consensus

Warning messages:
1: In rgl.init(initValue, onlyNULL) : RGL: unable to open X11 display
2: 'rgl_init' failed, running with rgl.useNULL = TRUE 
3: .onUnload failed in unloadNamespace() for 'rgl', details:
  call: fun(...)
  error: object 'rgl_quit' not found 

BALCONY documentation built on May 1, 2019, 10:31 p.m.