dstrace: A tracing utility for the GCAM Data System.

View source: R/dstrace.R

dstraceR Documentation

A tracing utility for the GCAM Data System.

Description

A tracing utility for the GCAM Data System.

Usage

dstrace(
  object_name,
  direction = "upstream",
  graph = FALSE,
  gcam_data_map = NULL,
  previous_tracelist = NULL,
  recurse = TRUE,
  print = TRUE,
  ...
)

Arguments

object_name

Name of object to trace (can be either a data object or a code chunk)

direction

Trace direction ("upstream", the default; "downstream"; or "both"), character

graph

Plot a directed graph of relationships? Logical

gcam_data_map

A tibble of metadata information; normally a built-in package dataset

previous_tracelist

Information about previous objects printed

recurse

Recurse to print information about precursor objects? Logical

print

Print trace to console? Logical

...

Extra arguments passed on to dstrace_plot

Details

What other data products feed into some particular data system object? Conversely, to what other products does some object feed? These are the kinds of questions that dstrace can help answer.

Value

A tibble with the trace information (object name and trace number), invisibly

Author(s)

BBL

Examples

dstrace("L100.FAO_ag_Exp_t")
dstrace("L100.FAO_ag_Exp_t", direction = "downstream")
dstrace("L100.FAO_ag_Exp_t", direction = "both", graph = TRUE)

JGCRI/gcamdata documentation built on March 21, 2023, 2:19 a.m.