Browse code

Add documentation

Leslie Myint authored on 16/08/2020 20:47:07
Showing1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,35 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/display.R
3
+\name{plot_path}
4
+\alias{plot_path}
5
+\title{Display path (plot form)}
6
+\usage{
7
+plot_path(graph, path)
8
+}
9
+\arguments{
10
+\item{graph}{The SemMed graph}
11
+
12
+\item{path}{A vertex sequence (\code{igraph.vs}) (the path to display)}
13
+}
14
+\value{
15
+A plot is created on the current graphics device
16
+}
17
+\description{
18
+Plot the graph form of a path
19
+}
20
+\details{
21
+All connections among nodes along the supplied path are plotted with 
22
+nodes labeled with their name and edges labeled with their predicate.
23
+}
24
+\examples{
25
+data(g_mini)
26
+
27
+node_cortisol <- find_nodes(g_mini, names = "Serum cortisol")
28
+node_stress <- find_nodes(g_mini, names = "Chronic Stress")
29
+paths <- find_paths(g_mini, from = node_cortisol, to = node_stress)
30
+plot_path(g_mini, paths[[1]][[1]])
31
+
32
+}
33
+\seealso{
34
+\code{\link{text_path}} for textual display of paths
35
+}