1. RBGL
  2. man
  3. extractPath.Rd
Browse code

repair edmondsOptimumBranching with new hpp files from atofigh address most BiocCheck issues except for registration of C++ routines

Vince Carey authored on 25/02/2018 16:39:43
Showing1 changed files
man/extractPath.Rd
History View file @c2a22f7
... ... 
@@ -28,6 +28,8 @@ by Jeremy G. Siek, Lie-Quan Lee, and Andrew Lumsdaine;
28 28 
 ISBN 0-201-72914-8
29 29 
 }
30 30
31 
+\value{numeric vector of indices of nodes along shortest path}
32 
+
31 33 
 \author{Vince Carey <stvjc@channing.harvard.edu>}
32 34
33 35 
 \seealso{  \code{\link[e1071:shortestPaths]{allShortestPaths}}}
Browse code

Fixed man page link warnings

git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/RBGL@41898 bc3139a8-67e5-0310-9ffc-ced21a209358

Nishant Gopalakrishnan authored on 23/09/2009 21:31:54
Showing1 changed files
man/extractPath.Rd
History View file @7fc3105
... ... 
@@ -30,7 +30,7 @@ ISBN 0-201-72914-8
30 30
31 31 
 \author{Vince Carey <stvjc@channing.harvard.edu>}
32 32
33 
-\seealso{  \code{\link[e1071]{allShortestPaths}}}
33 
+\seealso{  \code{\link[e1071:shortestPaths]{allShortestPaths}}}
34 34
35 35 
 \examples{
36 36 
 data(FileDep)
Browse code

better reference-section in man-pages

git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/RBGL@24555 bc3139a8-67e5-0310-9ffc-ced21a209358

Li Long authored on 09/05/2007 12:44:16
Showing1 changed files
man/extractPath.Rd
History View file @164a651
... ... 
@@ -1,13 +1,16 @@
1 1 
 \name{extractPath}
2 2 
 \alias{extractPath}
3 3 
 \title{convert a dijkstra.sp predecessor structure into the path joining two nodes   }
4 
+
4 5 
 \description{
5 6 
 determine a path between two nodes in a graph,
6 7 
 using output of \code{\link{dijkstra.sp}}.
7 8 
 }
9 
+
8 10 
 \usage{
9 11 
 extractPath(s, f, pens)
10 12 
 }
13 
+
11 14 
 \arguments{
12 15 
   \item{s}{ index of starting node in nodes vector
13 16 
 of the graph from which \code{pens} was derived}
... ... 
@@ -15,14 +18,17 @@ of the graph from which \code{pens} was derived}
15 18 
   \item{pens}{ predecessor index vector as returned
16 19 
 in the \code{preds} component of \code{\link{dijkstra.sp}} output}
17 20 
 }
18 
-%\details{
19 
-%}
20 
-%\value{
21 
-%}
22 
-%\references{  }
23 
-\author{Vince Carey <stvjc@channing.harvard.edu>}
24 
-%\note{  }
25 21
22 
+\references{
23 
+Boost Graph Library ( www.boost.org/libs/graph/doc/index.html )
24 
+
25 
+The Boost Graph Library: User Guide and Reference Manual;
26 
+by Jeremy G. Siek, Lie-Quan Lee, and Andrew Lumsdaine;
27 
+(Addison-Wesley, Pearson Education Inc., 2002), xxiv+321pp.
28 
+ISBN 0-201-72914-8
29 
+}
30 
+
31 
+\author{Vince Carey <stvjc@channing.harvard.edu>}
26 32
27 33 
 \seealso{  \code{\link[e1071]{allShortestPaths}}}
28 34
Browse code

Revert renaming to state as of rev 12332. All functions as they were before except for the min and max ones that were causing warnings on check. version bump to avoid any possible confusion .

git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/RBGL@12343 bc3139a8-67e5-0310-9ffc-ced21a209358

Seth Falcon authored on 12/05/2005 17:45:31
Showing1 changed files
man/extractPath.Rd
History View file @5f23463
... ... 
@@ -1,9 +1,9 @@
1 1 
 \name{extractPath}
2 2 
 \alias{extractPath}
3 
-\title{convert a dijkstraSP predecessor structure into the path joining two nodes   }
3 
+\title{convert a dijkstra.sp predecessor structure into the path joining two nodes   }
4 4 
 \description{
5 5 
 determine a path between two nodes in a graph,
6 
-using output of \code{\link{dijkstraSP}}.
6 
+using output of \code{\link{dijkstra.sp}}.
7 7 
 }
8 8 
 \usage{
9 9 
 extractPath(s, f, pens)
... ... 
@@ -13,7 +13,7 @@ extractPath(s, f, pens)
13 13 
 of the graph from which \code{pens} was derived}
14 14 
   \item{f}{ index of ending node in nodes vector }
15 15 
   \item{pens}{ predecessor index vector as returned
16 
-in the \code{preds} component of \code{\link{dijkstraSP}} output}
16 
+in the \code{preds} component of \code{\link{dijkstra.sp}} output}
17 17 
 }
18 18 
 %\details{
19 19 
 %}
... ... 
@@ -28,7 +28,7 @@ in the \code{preds} component of \code{\link{dijkstraSP}} output}
28 28
29 29 
 \examples{
30 30 
 data(FileDep)
31 
-dd <- dijkstraSP(FileDep)
31 
+dd <- dijkstra.sp(FileDep)
32 32 
 extractPath(1,9,dd$pen)
33 33 
 }
34 34 
 \keyword{ models }
Browse code

make function names follow the same naming convention

git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/RBGL@12335 bc3139a8-67e5-0310-9ffc-ced21a209358

Li Long authored on 12/05/2005 14:05:08
Showing1 changed files
man/extractPath.Rd
History View file @f8e82dc
... ... 
@@ -1,9 +1,9 @@
1 1 
 \name{extractPath}
2 2 
 \alias{extractPath}
3 
-\title{convert a dijkstra.sp predecessor structure into the path joining two nodes   }
3 
+\title{convert a dijkstraSP predecessor structure into the path joining two nodes   }
4 4 
 \description{
5 5 
 determine a path between two nodes in a graph,
6 
-using output of \code{\link{dijkstra.sp}}.
6 
+using output of \code{\link{dijkstraSP}}.
7 7 
 }
8 8 
 \usage{
9 9 
 extractPath(s, f, pens)
... ... 
@@ -13,7 +13,7 @@ extractPath(s, f, pens)
13 13 
 of the graph from which \code{pens} was derived}
14 14 
   \item{f}{ index of ending node in nodes vector }
15 15 
   \item{pens}{ predecessor index vector as returned
16 
-in the \code{preds} component of \code{\link{dijkstra.sp}} output}
16 
+in the \code{preds} component of \code{\link{dijkstraSP}} output}
17 17 
 }
18 18 
 %\details{
19 19 
 %}
... ... 
@@ -28,7 +28,7 @@ in the \code{preds} component of \code{\link{dijkstra.sp}} output}
28 28
29 29 
 \examples{
30 30 
 data(FileDep)
31 
-dd <- dijkstra.sp(FileDep)
31 
+dd <- dijkstraSP(FileDep)
32 32 
 extractPath(1,9,dd$pen)
33 33 
 }
34 34 
 \keyword{ models }
Browse code

update man pages for many functions

git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/RBGL@11461 bc3139a8-67e5-0310-9ffc-ced21a209358

Li Long authored on 15/03/2005 13:47:35
Showing1 changed files
man/extractPath.Rd
History View file @931d8b3
... ... 
@@ -1,7 +1,6 @@
1 1 
 \name{extractPath}
2 2 
 \alias{extractPath}
3 
-\title{convert a dijkstra.sp predecessor
4 
-structure into the path joining two nodes   }
3 
+\title{convert a dijkstra.sp predecessor structure into the path joining two nodes   }
5 4 
 \description{
6 5 
 determine a path between two nodes in a graph,
7 6 
 using output of \code{\link{dijkstra.sp}}.
... ... 
@@ -10,10 +9,10 @@ using output of \code{\link{dijkstra.sp}}.
10 9 
 extractPath(s, f, pens)
11 10 
 }
12 11 
 \arguments{
13 
-  \item{s}{ s: index of starting node in nodes vector
12 
+  \item{s}{ index of starting node in nodes vector
14 13 
 of the graph from which \code{pens} was derived}
15 
-  \item{f}{ f: index of ending node in nodes vector }
16 
-  \item{pens}{ pens: predecessor index vector as returned
14 
+  \item{f}{ index of ending node in nodes vector }
15 
+  \item{pens}{ predecessor index vector as returned
17 16 
 in the \code{preds} component of \code{\link{dijkstra.sp}} output}
18 17 
 }
19 18 
 %\details{
Browse code

now passes check; extractPath added/docd; pathWeights use demoted

git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/RBGL@8320 bc3139a8-67e5-0310-9ffc-ced21a209358

Vince Carey authored on 21/04/2004 21:17:42
Showing1 changed files
man/extractPath.Rd
History View file @0b6eec8
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,35 @@
1 
+\name{extractPath}
2 
+\alias{extractPath}
3 
+\title{convert a dijkstra.sp predecessor
4 
+structure into the path joining two nodes   }
5 
+\description{
6 
+determine a path between two nodes in a graph,
7 
+using output of \code{\link{dijkstra.sp}}.
8 
+}
9 
+\usage{
10 
+extractPath(s, f, pens)
11 
+}
12 
+\arguments{
13 
+  \item{s}{ s: index of starting node in nodes vector
14 
+of the graph from which \code{pens} was derived}
15 
+  \item{f}{ f: index of ending node in nodes vector }
16 
+  \item{pens}{ pens: predecessor index vector as returned
17 
+in the \code{preds} component of \code{\link{dijkstra.sp}} output}
18 
+}
19 
+%\details{
20 
+%}
21 
+%\value{
22 
+%}
23 
+%\references{  }
24 
+\author{Vince Carey <stvjc@channing.harvard.edu>}
25 
+%\note{  }
26 
+
27 
+
28 
+\seealso{  \code{\link[e1071]{allShortestPaths}}}
29 
+
30 
+\examples{
31 
+data(FileDep)
32 
+dd <- dijkstra.sp(FileDep)
33 
+extractPath(1,9,dd$pen)
34 
+}
35 
+\keyword{ models }