1. idpr
  2. man
  3. meanScaledHydropathy.Rd
Browse code

FoldIndexR addition

Package changes implementing the FoldIndexR() equation into idpr and the idprofiles.

WilliamMc authored on 11/03/2022 07:31:29
Showing1 changed files
man/meanScaledHydropathy.Rd
History View file @36a54e3
... ... 
@@ -46,6 +46,7 @@ Kyte, J., & Doolittle, R. F. (1982). A simple method for
46 46
47 47 
 Other scaled hydropathy functions:
48 48 
 \code{\link{KDNorm}},
49 
+\code{\link{foldIndexR}()},
49 50 
 \code{\link{scaledHydropathyGlobal}()},
50 51 
 \code{\link{scaledHydropathyLocal}()}
51 52 
 }
Browse code

Updating sequenceCheck

WilliamMc authored on 26/08/2020 22:50:34
Showing1 changed files
man/meanScaledHydropathy.Rd
History View file @73eecf4
... ... 
@@ -7,8 +7,8 @@
7 7 
 meanScaledHydropathy(sequence, roundScore = NA)
8 8 
 }
9 9 
 \arguments{
10 
-\item{sequence}{amino acid sequence as a single character string
11 
-or vector of single characters.
10 
+\item{sequence}{amino acid sequence as a single character string,
11 
+a vector of single characters, or an AAString object.
12 12 
 It also supports a single character string that specifies
13 13 
 the path to a .fasta or .fa file.}
14 14
Browse code

Proofreading Documentation

WilliamMc authored on 16/07/2020 22:26:29
Showing1 changed files
man/meanScaledHydropathy.Rd
History View file @5a22186
... ... 
@@ -30,7 +30,7 @@ aaVector <- c("A", "C", "D", "E", "F",
30 30 
               "G", "H", "I", "K", "L",
31 31 
               "M", "N", "P", "Q", "R",
32 32 
               "S", "T", "V", "W", "Y")
33 
- #Alternativly, .fasta files can also be used by providing
33 
+ #Alternatively, .fasta files can also be used by providing
34 34
35 35 
 #Calculate the mean scaled hydropathy
36 36 
  meanScaledHydropathy(aaString)
Browse code

Vignette and Documentation Updates

Proofreading and updating documentation for the package

WilliamMc authored on 17/06/2020 18:50:56
Showing1 changed files
man/meanScaledHydropathy.Rd
History View file @555cd2c
... ... 
@@ -10,7 +10,7 @@ meanScaledHydropathy(sequence, roundScore = NA)
10 10 
 \item{sequence}{amino acid sequence as a single character string
11 11 
 or vector of single characters.
12 12 
 It also supports a single character string that specifies
13 
-the locaion of a .fasta or .fa file.}
13 
+the path to a .fasta or .fa file.}
14 14
15 15 
 \item{roundScore}{Number of decimals the score will be rounded to.
16 16 
 NA by default.}
... ... 
@@ -19,7 +19,7 @@ NA by default.}
19 19 
 A numeric value equal to the Mean Scaled Hydropathy.
20 20 
 }
21 21 
 \description{
22 
-This funciton utlilizes the scaledHydropathyGlobal() function and
22 
+This function utilizes the scaledHydropathyGlobal() function and
23 23 
   easily returns the averaged hydropathy as a numeric value.
24 24 
 }
25 25 
 \examples{
Browse code

Added example documentation and combined similar scripts into the same file

WilliamMc authored on 05/06/2020 22:41:26
Showing1 changed files
man/meanScaledHydropathy.Rd
History View file @3554614
... ... 
@@ -1,5 +1,5 @@
1 1 
 % Generated by roxygen2: do not edit by hand
2 
-% Please edit documentation in R/meanScaledHydropathy.R
2 
+% Please edit documentation in R/scaledHydropathy.R
3 3 
 \name{meanScaledHydropathy}
4 4 
 \alias{meanScaledHydropathy}
5 5 
 \title{Calculate the Mean Scaled Hydropathy}
... ... 
@@ -22,6 +22,20 @@ A numeric value equal to the Mean Scaled Hydropathy.
22 22 
 This funciton utlilizes the scaledHydropathyGlobal() function and
23 23 
   easily returns the averaged hydropathy as a numeric value.
24 24 
 }
25 
+\examples{
26 
+#Amino acid sequences can be character strings
27 
+aaString <- "ACDEFGHIKLMNPQRSTVWY"
28 
+#Amino acid sequences can also be character vectors
29 
+aaVector <- c("A", "C", "D", "E", "F",
30 
+              "G", "H", "I", "K", "L",
31 
+              "M", "N", "P", "Q", "R",
32 
+              "S", "T", "V", "W", "Y")
33 
+ #Alternativly, .fasta files can also be used by providing
34 
+
35 
+#Calculate the mean scaled hydropathy
36 
+ meanScaledHydropathy(aaString)
37 
+ meanScaledHydropathy(aaVector)
38 
+}
25 39 
 \references{
26 40 
 Kyte, J., & Doolittle, R. F. (1982). A simple method for
27 41 
   displaying the hydropathic character of a protein.
Browse code

Initial commit

WilliamMc authored on 13/05/2020 00:45:34
Showing1 changed files
man/meanScaledHydropathy.Rd
History View file @1d5ed4a
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,38 @@
1 
+% Generated by roxygen2: do not edit by hand
2 
+% Please edit documentation in R/meanScaledHydropathy.R
3 
+\name{meanScaledHydropathy}
4 
+\alias{meanScaledHydropathy}
5 
+\title{Calculate the Mean Scaled Hydropathy}
6 
+\usage{
7 
+meanScaledHydropathy(sequence, roundScore = NA)
8 
+}
9 
+\arguments{
10 
+\item{sequence}{amino acid sequence as a single character string
11 
+or vector of single characters.
12 
+It also supports a single character string that specifies
13 
+the locaion of a .fasta or .fa file.}
14 
+
15 
+\item{roundScore}{Number of decimals the score will be rounded to.
16 
+NA by default.}
17 
+}
18 
+\value{
19 
+A numeric value equal to the Mean Scaled Hydropathy.
20 
+}
21 
+\description{
22 
+This funciton utlilizes the scaledHydropathyGlobal() function and
23 
+  easily returns the averaged hydropathy as a numeric value.
24 
+}
25 
+\references{
26 
+Kyte, J., & Doolittle, R. F. (1982). A simple method for
27 
+  displaying the hydropathic character of a protein.
28 
+  Journal of molecular biology, 157(1), 105-132.
29 
+}
30 
+\seealso{
31 
+\code{\link{KDNorm}} for residue values.
32 
+
33 
+Other scaled hydropathy functions:
34 
+\code{\link{KDNorm}},
35 
+\code{\link{scaledHydropathyGlobal}()},
36 
+\code{\link{scaledHydropathyLocal}()}
37 
+}
38 
+\concept{scaled hydropathy functions}