File: dot-register_graph_context.Rd

package info (click to toggle)
r-cran-tidygraph 1.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 736 kB
  • sloc: cpp: 35; sh: 13; makefile: 2
file content (21 lines) | stat: -rw-r--r-- 767 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/context.R
\name{.register_graph_context}
\alias{.register_graph_context}
\title{Register a graph context for the duration of the current frame}
\usage{
.register_graph_context(graph, free = FALSE, env = parent.frame())
}
\arguments{
\item{graph}{A \code{tbl_graph} object}

\item{free}{Should the active state of the graph be ignored?}

\item{env}{The environment where the context should be active}
}
\description{
This function sets the provided graph to be the context for tidygraph
algorithms, such as e.g. \code{\link[=node_is_center]{node_is_center()}}, for the duration of the current
environment. It automatically removes the graph once the environment exits.
}
\keyword{internal}