FacileAnalysisResultViz: Methods to interactively explore and report...

In facileverse/FacileAnalysis: Modularized and interactive analyses over a FacileDataStore

Methods to interactively explore and report FacileAnalysisResults.

Description

The vizualize, shine, and report triumverate provide the analyst with the tools required to interact and explore the results of a FacileAnalysis.

The vizualize, shine, and report triumverate provide the analyst with the tools required to interact and explore the results of a FacileAnalysis.

Usage

viz(x, ...)

report(x, ...)

viz(x, ...)

Arguments

x	A FacileAnalysisResult object
...	passed down to the x-specific ⁠vizualize.*⁠, ⁠report.*⁠, and ⁠shine.*⁠ functions.

Vizualize

The vizualize functions generate an analysis-specific interactive htmlwidget for the analysist to explore.

The vizualize functions generate an analysis-specific interactive htmlwidget for the analysist to explore.

Report

The report function produces an object that can be embedded into an Rmarkdown document. The implementation of these functions will likely result in a parameterized call to the respective vizualize function.

Two report functions should be created per FacileAnalysis. One that accepts the FacileAnalysisResult object itself, and another that accepts the analysis-specific FacileAnalysisShine object, which should parameterize the final visualize call so that it can be embedded seamlessly into an Rmarkdown report for "offline" viewing.

facileverse/FacileAnalysis documentation built on Nov. 23, 2024, 1:53 p.m.