File: write.entropy.Rd

package info (click to toggle)
r-cran-bios2cor 2.2.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,520 kB
  • sloc: makefile: 5
file content (57 lines) | stat: -rw-r--r-- 1,476 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
\name{write.entropy}

\Rdversion{1.1}

\alias{write.entropy}

\title{
  Writes and displays entropy values
}

\description{
  Given an entropy/dynamic_entropy object, writes each element (position or dihedral angle) and its entropy/dynamic_entropy value in a csv file, and displays the histogram. 
}

\usage{
  write.entropy(entropy, filepathroot )
}

\arguments{
 \item{entropy}{
  An object created by the \code{\link{entropy}} or the \code{\link{dynamic_entropy}} function.
 }
 \item{filepathroot}{
  The root of the full path name for the entropy output file. If NULL, a "ENTROPY.csv" file is created in tempdir(). If not NULL, a "_ENTROPY.csv" extension is added to filepathroot. 
 }
}

\details{
  The \code{\link{entropy}} function calculates entropy score for each position of an alignment file. The \code{\link{dynamic_entropy}}function calculate a "dynamic entropy" score for each side chain dihedral angle of a protein during a molecular simulations. 
}


\value{
  A csv file containing the elements and their scores. A png file displaying the histogram of the scores.
}

\author{
  Antoine GARNIER
}

\examples{
  #File path for output files
  out <- tempdir()
  file <- file.path(out,"test_seq") 

  #Importing multiple sequence alignment
  align <- import.msf(system.file("msa/human_gpcr.msf", package = "Bios2cor"))

  #Creating entropy object
  entropy <- entropy(align, gap_ratio = 0.2)
  
  #Writing results to csv file
  write.entropy(entropy, file)
}