File: sys_call_stack.Rd

package info (click to toggle)
r-cran-pkgmaker 0.32.10-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,192 kB
  • sloc: sh: 13; makefile: 2
file content (51 lines) | stat: -rw-r--r-- 1,249 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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils.R
\name{sys_call_stack}
\alias{sys_call_stack}
\alias{sys.function_digest}
\alias{sys.function_nframe}
\alias{sys.function_frame}
\alias{sys.source_file}
\title{System Call Stack Utilities}
\usage{
sys.function_digest(n = NULL)

sys.function_nframe(fun)

sys.function_frame(fun)

sys.source_file()
}
\arguments{
\item{n}{a single frame}

\item{fun}{the function object to find in the call stack.}
}
\value{
\itemize{
\item \code{sys.function_digest} returns a character vector of length \code{n}.
}

\itemize{
\item \code{sys.function_nframe} returns a integer vector.
}

\itemize{
\item \code{sys.function_frame} returns an environment.
}
}
\description{
System Call Stack Utilities
}
\section{Functions}{
\itemize{
\item \code{sys.function_digest()}: computes digest hash for each function in the call stack.

\item \code{sys.function_nframe()}: returns the index of the frame that calls a given function.

\item \code{sys.function_frame()}: returns the frame that calls a given function.

\item \code{sys.source_file()}: returns path to the script that is being sourced either
by \link[base:source]{base::source} or \link[base:sys.source]{base::sys.source}.

}}