Function printDfGraphForCode

Visualizes the dataflow graph of the given R code using the given parser. This function returns a markdown string containing the dataflow graph as a mermaid code block, along with the R code itself in a collapsible section.

printDfGraphForCode(
    parser: KnownParser,
    code: string,
    options: PrintDataflowGraphOptions & { exposeResult: true },
): Promise<[string, PipelineOutput<Pipeline<(...) | (...) | (...)>>]>
Parameters
- parser: KnownParser
- code: string
- options: PrintDataflowGraphOptions & { exposeResult: true }
Returns Promise<[string, PipelineOutput<Pipeline<(...) | (...) | (...)>>]>
- Defined in src/documentation/doc-util/doc-dfg.ts:59
printDfGraphForCode(
    parser: KnownParser,
    code: string,
    options?: PrintDataflowGraphOptions & { exposeResult?: false },
): Promise<string>
Parameters
- parser: KnownParser
- code: string
- Optionaloptions: PrintDataflowGraphOptions & { exposeResult?: false }
Returns Promise<string>
- Defined in src/documentation/doc-util/doc-dfg.ts:60

Function printDfGraphForCode

Parameters

Returns Promise<[string, PipelineOutput<Pipeline<(...) | (...) | (...)>>]>

Parameters

Returns Promise<string>

Settings