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,45 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/display.R
3
+\name{text_path}
4
+\alias{text_path}
5
+\title{Display path (text form)}
6
+\usage{
7
+text_path(graph, path, print = TRUE)
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
+\item{print}{Print the path to screen?}
15
+}
16
+\value{
17
+Invisibly returns a list of predications for each pair
18
+of nodes along the path.
19
+}
20
+\description{
21
+Show a text display of a path and obtain output that can
22
+be used to explore predications along the path. (A predication 
23
+is a SUBJECT--LINKING VERB-->OBJECT triple.)
24
+}
25
+\details{
26
+\code{text_path} invisibly returns a list of \code{tbl}'s containing
27
+information on the predications on the path. Each list element is a 
28
+\code{tbl} that corresponds to a (sequential) pair of nodes along 
29
+the path. The \code{tbl} contains information on the subject and 
30
+object node's name and semantic type as well as all predicates linking 
31
+the subject and object.
32
+}
33
+\examples{
34
+data(g_mini)
35
+
36
+node_cortisol <- find_nodes(g_mini, names = "Serum cortisol")
37
+node_stress <- find_nodes(g_mini, names = "Chronic Stress")
38
+paths <- find_paths(g_mini, from = node_cortisol, to = node_stress)
39
+text_path(g_mini, paths[[1]][[1]])
40
+result <- text_path(g_mini, paths[[1]][[1]], print = FALSE)
41
+
42
+}
43
+\seealso{
44
+\code{\link{plot_path}} for plotting paths
45
+}