Browse code

[Doc] Used devtools::document() to reflect changes from R files to man/ pages

shubham1637 authored on 04/02/2020 16:29:02
Showing 44 changed files

... ...
@@ -6,7 +6,13 @@
6 6
 \alias{AffineAlignObj}
7 7
 \title{An S4 object for class AffineAlignObj}
8 8
 \description{
9
-An S4 object for class AffineAlignObj
9
+s is a point-wise similarity matrix between signalA and signalB.
10
+Intermediate matrices M,A,B are calculated from s for affine-alignment. Each cell of the Traceback
11
+matrix has coordinate of its parent cell. path matrix is a binary matrix with ones indicating path
12
+of maximum cumulative score.
13
+GapOpen and GapExten are gap-opening and gap-extension penalties used by affine alignment algorithm.
14
+indexA_aligned and indexB_aligned are aligned indices of signalA and SignalB. The cumulative
15
+alignment score is in score vector.
10 16
 }
11 17
 \seealso{
12 18
 \code{\link{doAffineAlignmentCpp}}
... ...
@@ -16,6 +22,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
16 22
 
17 23
 ORCID: 0000-0003-3500-8152
18 24
 
19
-License: (c) Author (2019) + MIT
25
+License: (c) Author (2019) + GPL-3
20 26
 Date: 2019-12-14
21 27
 }
... ...
@@ -6,7 +6,8 @@
6 6
 \alias{AffineAlignObjLight}
7 7
 \title{An S4 object for class AffineAlignObj. It only contains aligned indices.}
8 8
 \description{
9
-An S4 object for class AffineAlignObj. It only contains aligned indices.
9
+indexA_aligned and indexB_aligned are aligned indices of signalA and SignalB. The cumulative
10
+alignment score is in score vector.
10 11
 }
11 12
 \seealso{
12 13
 \code{\link{doAffineAlignmentCpp}}
... ...
@@ -16,6 +17,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
16 17
 
17 18
 ORCID: 0000-0003-3500-8152
18 19
 
19
-License: (c) Author (2019) + MIT
20
+License: (c) Author (2019) + GPL-3
20 21
 Date: 2019-12-14
21 22
 }
... ...
@@ -6,7 +6,11 @@
6 6
 \alias{AffineAlignObjMedium}
7 7
 \title{An S4 object for class AffineAlignObj. It only contains similarity matrix and aligned indices.}
8 8
 \description{
9
-An S4 object for class AffineAlignObj. It only contains similarity matrix and aligned indices.
9
+s is a point-wise similarity matrix between signalA and signalB.
10
+path matrix is a binary matrix with ones indicating path of maximum cumulative score.
11
+GapOpen and GapExten are gap-opening and gap-extension penalties used by affine alignment algorithm.
12
+indexA_aligned and indexB_aligned are aligned indices of signalA and SignalB. The cumulative
13
+alignment score is in score vector.
10 14
 }
11 15
 \seealso{
12 16
 \code{\link{doAffineAlignmentCpp}}
... ...
@@ -16,6 +20,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
16 20
 
17 21
 ORCID: 0000-0003-3500-8152
18 22
 
19
-License: (c) Author (2019) + MIT
23
+License: (c) Author (2019) + GPL-3
20 24
 Date: 2019-12-14
21 25
 }
... ...
@@ -6,7 +6,13 @@
6 6
 \alias{AlignObj}
7 7
 \title{An S4 object for class AlignObj}
8 8
 \description{
9
-An S4 object for class AlignObj
9
+s is a point-wise similarity matrix between signalA and signalB.
10
+Intermediate matrices M is calculated from s for alignment. Each cell of the Traceback
11
+matrix has coordinate of its parent cell. path matrix is a binary matrix with ones indicating path
12
+of maximum cumulative score.
13
+GapOpen and GapExten are gap-opening and gap-extension penalties used by alignment algorithm. They
14
+must be the same. indexA_aligned and indexB_aligned are aligned indices of signalA and SignalB.
15
+The cumulative alignment score is in score vector.
10 16
 }
11 17
 \seealso{
12 18
 \code{\link{doAlignmentCpp}}
... ...
@@ -16,6 +22,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
16 22
 
17 23
 ORCID: 0000-0003-3500-8152
18 24
 
19
-License: (c) Author (2019) + MIT
25
+License: (c) Author (2019) + GPL-3
20 26
 Date: 2019-12-14
21 27
 }
... ...
@@ -11,7 +11,8 @@
11 11
   \item{intensity}{Intensity of signal for the transition}
12 12
 }}
13 13
 \source{
14
-data-raw/test_GenerateData.R has source code.
14
+Raw files are downloaded from [Peptide Atlas](http://www.peptideatlas.org/PASS/PASS01508).
15
+data-raw/test_GenerateData.R has [source code](https://github.com/shubham1637/DIAlignR/tree/master/data-raw).
15 16
 }
16 17
 \usage{
17 18
 XIC_QFNNTDIVLLEDFQK_3_DIAlignR
... ...
@@ -101,6 +101,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
101 101
 
102 102
 ORCID: 0000-0003-3500-8152
103 103
 
104
-License: (c) Author (2019) + MIT
104
+License: (c) Author (2019) + GPL-3
105 105
 Date: 2019-12-14
106 106
 }
... ...
@@ -9,9 +9,9 @@ areaIntegrator(l1, leftIdx, rightIdx)
9 9
 \arguments{
10 10
 \item{l1}{(list) A list of vectors. All vectors must be of same length.}
11 11
 
12
-\item{leftIdx}{(numeric) Left index of the boundary.}
12
+\item{leftIdx}{(numeric) Left index (0-based) of the boundary.}
13 13
 
14
-\item{rightIdx}{(numeric) Right index of the boundary.}
14
+\item{rightIdx}{(numeric) Right index (0-based) of the boundary.}
15 15
 }
16 16
 \value{
17 17
 area (numeric).
... ...
@@ -19,6 +19,10 @@ area (numeric).
19 19
 \description{
20 20
 This function sums all the intensities between left-index and right-index.
21 21
 }
22
+\examples{
23
+l1 <- list(1:10, 1:10, 1:10)
24
+areaIntegrator(l1, leftIdx = 4, rightIdx = 6) # 54
25
+}
22 26
 \author{
23 27
 Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
24 28
 ORCID: 0000-0003-3500-8152
... ...
@@ -22,7 +22,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
22 22
 
23 23
 ORCID: 0000-0003-3500-8152
24 24
 
25
-License: (c) Author (2019) + MIT
25
+License: (c) Author (2019) + GPL-3
26 26
 Date: 2019-12-13
27 27
 }
28 28
 \keyword{internal}
... ...
@@ -27,23 +27,23 @@ Match=10; MisMatch=-2
27 27
 seq1 = "GCAT"; seq2 = "CAGTG"
28 28
 s <- getSeqSimMatCpp(seq1, seq2, Match, MisMatch)
29 29
 objAffine_Global <- doAffineAlignmentCpp(s, 22, 7, FALSE)
30
-objAffine_Global@score # -2  -4  -6  4 -18
30
+slot(objAffine_Global, "score") # -2  -4  -6  4 -18
31 31
 objAffine_Olap <- doAffineAlignmentCpp(s, 22, 7, TRUE)
32
-objAffine_Olap@score # 0 10 20 18 18 18
32
+slot(objAffine_Olap, "score") # 0 10 20 18 18 18
33 33
 
34 34
 Match=10; MisMatch=-2
35 35
 seq1 = "CAT"; seq2 = "CAGTG"
36 36
 s <- getSeqSimMatCpp(seq1, seq2, Match, MisMatch)
37 37
 objAffine_Global <- doAffineAlignmentCpp(s, 22, 7, FALSE)
38
-objAffine_Global@score # 10  20  -2  -9 -11
38
+slot(objAffine_Global, "score") # 10  20  -2  -9 -11
39 39
 objAffine_Olap <- doAffineAlignmentCpp(s, 22, 7, TRUE)
40
-objAffine_Olap@score # 10 20 18 18 18
40
+slot(objAffine_Olap, "score") # 10 20 18 18 18
41 41
 
42 42
 Match=10; MisMatch=-2
43 43
 seq1 = "CA"; seq2 = "AG"
44 44
 s <- getSeqSimMatCpp(seq1, seq2, Match, MisMatch)
45 45
 objAffine_Global <- doAffineAlignmentCpp(s, 22, 7, FALSE)
46
-objAffine_Global@simScore_forw # -4
46
+slot(objAffine_Global, "simScore_forw") # -4
47 47
 }
48 48
 \author{
49 49
 Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
... ...
@@ -25,17 +25,17 @@ Match=10; MisMatch=-2
25 25
 seq1 = "GCAT"; seq2 = "CAGTG"
26 26
 s <- getSeqSimMatCpp(seq1, seq2, Match, MisMatch)
27 27
 obj_Global <- doAlignmentCpp(s, 22, FALSE)
28
-obj_Global@score # -2 -4 -6 4 -18
28
+slot(obj_Global, "score") # -2 -4 -6 4 -18
29 29
 obj_Olap <- doAlignmentCpp(s, 22, TRUE)
30
-obj_Olap@score # 0 10 20 18 18 18
30
+slot(obj_Olap, "score") # 0 10 20 18 18 18
31 31
 
32 32
 Match=1; MisMatch=-1
33 33
 seq1 = "TTTC"; seq2 = "TGC"
34 34
 s <- getSeqSimMatCpp(seq1, seq2, Match, MisMatch)
35 35
 obj_Global <- doAlignmentCpp(s, 2, FALSE)
36
-obj_Global@optionalPaths
36
+slot(obj_Global, "optionalPaths")
37 37
 matrix(data = c(1,1,1,1,1,1,1,1,1,2,1,2,1,3,3,1,1,3,6,3), nrow = 5, ncol =4, byrow = TRUE)
38
-obj_Global@M_forw
38
+slot(obj_Global, "M_forw")
39 39
 matrix(data = c(0,-2,-4,-6,-2,-7,-22,-45,-4,-20,-72,-184,-6,-41,-178,-547,-8,-72,-366,-1274),
40 40
  nrow = 5, ncol =4, byrow = TRUE)
41 41
 }
... ...
@@ -38,7 +38,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
38 38
 
39 39
 ORCID: 0000-0003-3500-8152
40 40
 
41
-License: (c) Author (2019) + MIT
41
+License: (c) Author (2019) + GPL-3
42 42
 Date: 2019-12-13
43 43
 }
44 44
 \keyword{internal}
... ...
@@ -61,7 +61,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
61 61
 
62 62
 ORCID: 0000-0003-3500-8152
63 63
 
64
-License: (c) Author (2019) + MIT
64
+License: (c) Author (2019) + GPL-3
65 65
 Date: 2019-12-13
66 66
 }
67 67
 \keyword{internal}
... ...
@@ -26,7 +26,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
26 26
 
27 27
 ORCID: 0000-0003-3500-8152
28 28
 
29
-License: (c) Author (2019) + MIT
29
+License: (c) Author (2019) + GPL-3
30 30
 Date: 2019-12-14
31 31
 }
32 32
 \keyword{internal}
... ...
@@ -29,7 +29,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
29 29
 
30 30
 ORCID: 0000-0003-3500-8152
31 31
 
32
-License: (c) Author (2019) + MIT
32
+License: (c) Author (2019) + GPL-3
33 33
 Date: 2019-12-14
34 34
 }
35 35
 \keyword{internal}
... ...
@@ -72,6 +72,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
72 72
 
73 73
 ORCID: 0000-0003-3500-8152
74 74
 
75
-License: (c) Author (2019) + MIT
75
+License: (c) Author (2019) + GPL-3
76 76
 Date: 2019-12-13
77 77
 }
... ...
@@ -105,6 +105,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
105 105
 
106 106
 ORCID: 0000-0003-3500-8152
107 107
 
108
-License: (c) Author (2019) + MIT
108
+License: (c) Author (2019) + GPL-3
109 109
 Date: 2019-12-14
110 110
 }
... ...
@@ -24,7 +24,7 @@ and second column indicates intensity.}
24 24
 A plot to the current device.
25 25
 }
26 26
 \description{
27
-AlignObjOutput is the output from getAlignObjs fucntion.
27
+AlignObj is the output from getAlignObjs fucntion. This function prepares ggplot objects from AlignObj.
28 28
 }
29 29
 \examples{
30 30
 dataPath <- system.file("extdata", package = "DIAlignR")
... ...
@@ -41,7 +41,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
41 41
 
42 42
 ORCID: 0000-0003-3500-8152
43 43
 
44
-License: (c) Author (2019) + MIT
44
+License: (c) Author (2019) + GPL-3
45 45
 Date: 2019-12-13
46 46
 }
47 47
 \keyword{internal}
... ...
@@ -47,6 +47,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
47 47
 
48 48
 ORCID: 0000-0003-3500-8152
49 49
 
50
-License: (c) Author (2019) + MIT
50
+License: (c) Author (2019) + GPL-3
51 51
 Date: 2019-12-14
52 52
 }
... ...
@@ -33,7 +33,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
33 33
 
34 34
 ORCID: 0000-0003-3500-8152
35 35
 
36
-License: (c) Author (2019) + MIT
36
+License: (c) Author (2019) + GPL-3
37 37
 Date: 2019-12-14
38 38
 }
39 39
 \keyword{internal}
... ...
@@ -32,7 +32,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
32 32
 
33 33
 ORCID: 0000-0003-3500-8152
34 34
 
35
-License: (c) Author (2019) + MIT
35
+License: (c) Author (2019) + GPL-3
36 36
 Date: 2019-12-14
37 37
 }
38 38
 \keyword{internal}
... ...
@@ -40,6 +40,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
40 40
 
41 41
 ORCID: 0000-0003-3500-8152
42 42
 
43
-License: (c) Author (2019) + MIT
43
+License: (c) Author (2019) + GPL-3
44 44
 Date: 2019-12-14
45 45
 }
... ...
@@ -39,7 +39,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
39 39
 
40 40
 ORCID: 0000-0003-3500-8152
41 41
 
42
-License: (c) Author (2019) + MIT
42
+License: (c) Author (2019) + GPL-3
43 43
 Date: 2019-12-14
44 44
 }
45 45
 \keyword{internal}
... ...
@@ -37,7 +37,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
37 37
 
38 38
 ORCID: 0000-0003-3500-8152
39 39
 
40
-License: (c) Author (2019) + MIT
40
+License: (c) Author (2019) + GPL-3
41 41
 Date: 2019-12-14
42 42
 }
43 43
 \keyword{internal}
... ...
@@ -28,6 +28,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
28 28
 
29 29
 ORCID: 0000-0003-3500-8152
30 30
 
31
-License: (c) Author (2019) + MIT
31
+License: (c) Author (2019) + GPL-3
32 32
 Date: 2019-12-13
33 33
 }
... ...
@@ -75,6 +75,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
75 75
 
76 76
 ORCID: 0000-0003-3500-8152
77 77
 
78
-License: (c) Author (2019) + MIT
78
+License: (c) Author (2019) + GPL-3
79 79
 Date: 2019-12-13
80 80
 }
... ...
@@ -52,6 +52,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
52 52
 
53 53
 ORCID: 0000-0003-3500-8152
54 54
 
55
-License: (c) Author (2019) + MIT
55
+License: (c) Author (2019) + GPL-3
56 56
 Date: 2019-12-13
57 57
 }
... ...
@@ -61,6 +61,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
61 61
 
62 62
 ORCID: 0000-0003-3500-8152
63 63
 
64
-License: (c) Author (2019) + MIT
64
+License: (c) Author (2019) + GPL-3
65 65
 Date: 2019-12-13
66 66
 }
... ...
@@ -32,7 +32,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
32 32
 
33 33
 ORCID: 0000-0003-3500-8152
34 34
 
35
-License: (c) Author (2019) + MIT
35
+License: (c) Author (2019) + GPL-3
36 36
 Date: 2019-12-14
37 37
 }
38 38
 \keyword{internal}
... ...
@@ -32,7 +32,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
32 32
 
33 33
 ORCID: 0000-0003-3500-8152
34 34
 
35
-License: (c) Author (2019) + MIT
35
+License: (c) Author (2019) + GPL-3
36 36
 Date: 2019-12-13
37 37
 }
38 38
 \keyword{internal}
... ...
@@ -31,6 +31,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
31 31
 
32 32
 ORCID: 0000-0003-3500-8152
33 33
 
34
-License: (c) Author (2019) + MIT
34
+License: (c) Author (2019) + GPL-3
35 35
 Date: 2019-12-14
36 36
 }
... ...
@@ -53,6 +53,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
53 53
 
54 54
 ORCID: 0000-0003-3500-8152
55 55
 
56
-License: (c) Author (2019) + MIT
56
+License: (c) Author (2019) + GPL-3
57 57
 Date: 2019-12-13
58 58
 }
... ...
@@ -49,6 +49,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
49 49
 
50 50
 ORCID: 0000-0003-3500-8152
51 51
 
52
-License: (c) Author (2019) + MIT
52
+License: (c) Author (2019) + GPL-3
53 53
 Date: 2019-12-13
54 54
 }
... ...
@@ -31,6 +31,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
31 31
 
32 32
 ORCID: 0000-0003-3500-8152
33 33
 
34
-License: (c) Author (2019) + MIT
34
+License: (c) Author (2019) + GPL-3
35 35
 Date: 2019-12-13
36 36
 }
... ...
@@ -35,7 +35,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
35 35
 
36 36
 ORCID: 0000-0003-3500-8152
37 37
 
38
-License: (c) Author (2019) + MIT
38
+License: (c) Author (2019) + GPL-3
39 39
 Date: 2019-12-13
40 40
 }
41 41
 \keyword{internal}
... ...
@@ -30,7 +30,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
30 30
 
31 31
 ORCID: 0000-0003-3500-8152
32 32
 
33
-License: (c) Author (2019) + MIT
33
+License: (c) Author (2019) + GPL-3
34 34
 Date: 2019-12-13
35 35
 }
36 36
 \keyword{internal}
... ...
@@ -20,7 +20,8 @@
20 20
   \item{transition_ids}{Transition IDs (chromatogram IDs) of the feature}
21 21
 }}
22 22
 \source{
23
-data-raw/test_GenerateData.R has source code.
23
+Raw files are downloaded from [Peptide Atlas](http://www.peptideatlas.org/PASS/PASS01508).
24
+data-raw/test_GenerateData.R has [source code](https://github.com/shubham1637/DIAlignR/tree/master/data-raw).
24 25
 }
25 26
 \usage{
26 27
 oswFiles_DIAlignR
... ...
@@ -47,7 +47,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
47 47
 
48 48
 ORCID: 0000-0003-3500-8152
49 49
 
50
-License: (c) Author (2019) + MIT
50
+License: (c) Author (2019) + GPL-3
51 51
 Date: 2019-12-13
52 52
 }
53 53
 \keyword{internal}
... ...
@@ -38,6 +38,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
38 38
 
39 39
 ORCID: 0000-0003-3500-8152
40 40
 
41
-License: (c) Author (2019) + MIT
41
+License: (c) Author (2019) + GPL-3
42 42
 Date: 2019-12-13
43 43
 }
... ...
@@ -30,6 +30,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
30 30
 
31 31
 ORCID: 0000-0003-3500-8152
32 32
 
33
-License: (c) Author (2019) + MIT
33
+License: (c) Author (2019) + GPL-3
34 34
 Date: 2019-12-13
35 35
 }
... ...
@@ -55,6 +55,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
55 55
 
56 56
 ORCID: 0000-0003-3500-8152
57 57
 
58
-License: (c) Author (2019) + MIT
58
+License: (c) Author (2019) + GPL-3
59 59
 Date: 2019-12-13
60 60
 }
... ...
@@ -28,7 +28,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
28 28
 
29 29
 ORCID: 0000-0003-3500-8152
30 30
 
31
-License: (c) Author (2019) + MIT
31
+License: (c) Author (2019) + GPL-3
32 32
 Date: 2019-12-13
33 33
 }
34 34
 \keyword{internal}
... ...
@@ -37,6 +37,6 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
37 37
 
38 38
 ORCID: 0000-0003-3500-8152
39 39
 
40
-License: (c) Author (2019) + MIT
40
+License: (c) Author (2019) + GPL-3
41 41
 Date: 2019-12-13
42 42
 }
... ...
@@ -29,7 +29,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
29 29
 
30 30
 ORCID: 0000-0003-3500-8152
31 31
 
32
-License: (c) Author (2019) + MIT
32
+License: (c) Author (2019) + GPL-3
33 33
 Date: 2019-12-13
34 34
 }
35 35
 \keyword{internal}
... ...
@@ -35,7 +35,7 @@ Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
35 35
 
36 36
 ORCID: 0000-0003-3500-8152
37 37
 
38
-License: (c) Author (2019) + MIT
38
+License: (c) Author (2019) + GPL-3
39 39
 Date: 2019-12-13
40 40
 }
41 41
 \keyword{internal}