1. DIAlignR
  2. man
  3. plotAlignmentPath.Rd
Browse code

[Fix] In tandem with the current version of getAlignObjs

shubham1637 authored on 18/04/2020 00:51:30
Showing1 changed files
man/plotAlignmentPath.Rd
History View file @6223665
... ... 
@@ -21,8 +21,7 @@ library(lattice)
21 21 
 dataPath <- system.file("extdata", package = "DIAlignR")
22 22 
 runs <- c("hroest_K120809_Strep0\%PlasmaBiolRepl2_R04_SW_filt",
23 23 
  "hroest_K120809_Strep10\%PlasmaBiolRepl2_R04_SW_filt")
24 
-AlignObjOutput <- getAlignObjs(analytes = "QFNNTDIVLLEDFQK_3", runs, dataPath = dataPath,
25 
- objType = "medium")
24 
+AlignObjOutput <- getAlignObjs(analytes = 4618L, runs, dataPath = dataPath, objType = "medium")
26 25 
 plotAlignmentPath(AlignObjOutput)
27 26 
 }
28 27 
 \author{
Browse code

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

shubham1637 authored on 04/02/2020 16:29:02
Showing1 changed files
man/plotAlignmentPath.Rd
History View file @3845e0a
... ... 
@@ -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 
 }
Browse code

[Bioc] return is set as A plot to the current device

shubham1637 authored on 18/12/2019 20:39:38
Showing1 changed files
man/plotAlignmentPath.Rd
History View file @d172d7c
... ... 
@@ -9,6 +9,9 @@ plotAlignmentPath(AlignObjOutput)
9 9 
 \arguments{
10 10 
 \item{AlignObjOutput}{(list) The list contains AlignObj, raw XICs for reference and experiment, and reference-peak label.}
11 11 
 }
12 
+\value{
13 
+A plot to the current device.
14 
+}
12 15 
 \description{
13 16 
 Plot aligned path through the similarity matrix. Reference run has indices on X-axis, eXp run has them on Y-axis.
14 17 
 In getAlignObjs function, objType must be set to medium.
Browse code

[Doc] Completed documentation of visualise_chromatogram.R

shubham1637 authored on 17/12/2019 18:01:51
Showing1 changed files
man/plotAlignmentPath.Rd
History View file @a476bce
... ... 
@@ -6,6 +6,9 @@
6 6 
 \usage{
7 7 
 plotAlignmentPath(AlignObjOutput)
8 8 
 }
9 
+\arguments{
10 
+\item{AlignObjOutput}{(list) The list contains AlignObj, raw XICs for reference and experiment, and reference-peak label.}
11 
+}
9 12 
 \description{
10 13 
 Plot aligned path through the similarity matrix. Reference run has indices on X-axis, eXp run has them on Y-axis.
11 14 
 In getAlignObjs function, objType must be set to medium.
Browse code

[Fix] corrected the spelling mistake for plotAlignmentPath

shubham1637 authored on 16/12/2019 16:27:20
Showing1 changed files
man/plotAlignmentPath.Rd
History View file @091233d
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,29 @@
1 
+% Generated by roxygen2: do not edit by hand
2 
+% Please edit documentation in R/visualise_chromatograms.R
3 
+\name{plotAlignmentPath}
4 
+\alias{plotAlignmentPath}
5 
+\title{Visualize alignment path through similarity matrix}
6 
+\usage{
7 
+plotAlignmentPath(AlignObjOutput)
8 
+}
9 
+\description{
10 
+Plot aligned path through the similarity matrix. Reference run has indices on X-axis, eXp run has them on Y-axis.
11 
+In getAlignObjs function, objType must be set to medium.
12 
+}
13 
+\examples{
14 
+library(lattice)
15 
+dataPath <- system.file("extdata", package = "DIAlignR")
16 
+runs <- c("hroest_K120809_Strep0\%PlasmaBiolRepl2_R04_SW_filt",
17 
+ "hroest_K120809_Strep10\%PlasmaBiolRepl2_R04_SW_filt")
18 
+AlignObjOutput <- getAlignObjs(analytes = "QFNNTDIVLLEDFQK_3", runs, dataPath = dataPath,
19 
+ objType = "medium")
20 
+plotAlignmentPath(AlignObjOutput)
21 
+}
22 
+\author{
23 
+Shubham Gupta, \email{shubh.gupta@mail.utoronto.ca}
24 
+
25 
+ORCID: 0000-0003-3500-8152
26 
+
27 
+License: (c) Author (2019) + MIT
28 
+Date: 2019-12-13
29 
+}