File: get_family_pd.Rd

package info (click to toggle)
r-cran-parsetools 0.1.3-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 780 kB
  • sloc: sh: 13; makefile: 2
file content (37 lines) | stat: -rw-r--r-- 871 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/family.R
\name{get_family_pd}
\alias{get_family_pd}
\title{Get family of nodes.}
\usage{
get_family_pd(
  id,
  pd,
  include.self = TRUE,
  ngenerations = Inf,
  ...,
  include.doc.comments = TRUE,
  include.regular.comments = FALSE
)
}
\arguments{
\item{id}{id of the expression of interest}

\item{pd}{The \code{\link{parse-data}} information}

\item{include.self}{Should the root node (\code{id}) be included?}

\item{ngenerations}{Number of generations to go forwards or backwards.}

\item{...}{currently ignored.}

\item{include.doc.comments}{include associated documentation comments.}

\item{include.regular.comments}{include associated regular comments.}
}
\value{
a subset of the \code{\link{parse-data}} \code{pd}.
}
\description{
Subset the \code{pd} to the family of \code{id}.
}