man/meanScaledHydropathy.Rd
1d5ed4a6
 % Generated by roxygen2: do not edit by hand
35546149
 % Please edit documentation in R/scaledHydropathy.R
1d5ed4a6
 \name{meanScaledHydropathy}
 \alias{meanScaledHydropathy}
 \title{Calculate the Mean Scaled Hydropathy}
 \usage{
 meanScaledHydropathy(sequence, roundScore = NA)
 }
 \arguments{
73eecf42
 \item{sequence}{amino acid sequence as a single character string,
 a vector of single characters, or an AAString object.
1d5ed4a6
 It also supports a single character string that specifies
555cd2c4
 the path to a .fasta or .fa file.}
1d5ed4a6
 
 \item{roundScore}{Number of decimals the score will be rounded to.
 NA by default.}
 }
 \value{
 A numeric value equal to the Mean Scaled Hydropathy.
 }
 \description{
555cd2c4
 This function utilizes the scaledHydropathyGlobal() function and
1d5ed4a6
   easily returns the averaged hydropathy as a numeric value.
 }
35546149
 \examples{
 #Amino acid sequences can be character strings
 aaString <- "ACDEFGHIKLMNPQRSTVWY"
 #Amino acid sequences can also be character vectors
 aaVector <- c("A", "C", "D", "E", "F",
               "G", "H", "I", "K", "L",
               "M", "N", "P", "Q", "R",
               "S", "T", "V", "W", "Y")
5a22186e
  #Alternatively, .fasta files can also be used by providing
35546149
 
 #Calculate the mean scaled hydropathy
  meanScaledHydropathy(aaString)
  meanScaledHydropathy(aaVector)
 }
1d5ed4a6
 \references{
 Kyte, J., & Doolittle, R. F. (1982). A simple method for
   displaying the hydropathic character of a protein.
   Journal of molecular biology, 157(1), 105-132.
 }
 \seealso{
 \code{\link{KDNorm}} for residue values.
 
 Other scaled hydropathy functions: 
 \code{\link{KDNorm}},
36a54e3c
 \code{\link{foldIndexR}()},
1d5ed4a6
 \code{\link{scaledHydropathyGlobal}()},
 \code{\link{scaledHydropathyLocal}()}
 }
 \concept{scaled hydropathy functions}