[Seqinr-commits] r2123 - pkg/man

[noreply at r-forge.r-project.org]

Author: simonpenel
Date: 2021-05-20 11:47:39 +0200 (Thu, 20 May 2021)
New Revision: 2123

Modified:
   pkg/man/AAstat.Rd
Log:
More details on AAstat in the doc

Modified: pkg/man/AAstat.Rd
===================================================================
--- pkg/man/AAstat.Rd	2021-05-20 09:41:25 UTC (rev 2122)
+++ pkg/man/AAstat.Rd	2021-05-20 09:47:39 UTC (rev 2123)
@@ -2,8 +2,9 @@
 \alias{AAstat}
 \title{ To Get Some Protein Statistics }
 \description{
-  Returns simple protein sequence information including the number of residues, 
+  Returns simple protein sequence information including the number of residues,
   the percentage physico-chemical classes and the theoretical isoelectric point.
+  The functions ignore ambiguous amino acids (e.g. "B", "Z", "X", "J").
 }
 \usage{
 AAstat(seq, plot = TRUE)
@@ -10,11 +11,11 @@
 }
 \arguments{
   \item{seq}{ a protein sequence as a vector of upper-case chars }
-  \item{plot}{ if \code{TRUE}, plots the presence of residues splited by 
+  \item{plot}{ if \code{TRUE}, plots the presence of residues splited by
   physico-chemical classes along the sequence. }
 }
 \value{
-  A list with the three following components: 
+  A list with the three following components:
   \item{Compo}{A factor giving the amino acid counts.}
   \item{Prop}{A list giving the percentage of each physico-chemical classes
   (Tiny, Small, Aliphatic, Aromatic, Non-polar, Polar, Charged, Positive, Negative).}