Skip to contents

Package index

Visualize

Generate a visualization from the Assessment results

Visualize_Metric() stable
Visualize_Metric Function
Visualize_Scatter() stable
Group-level visualization of group-level results
Visualize_Score() stable
Group-level visualization of scores.
Widget_BarChartOutput() renderWidget_BarChart() stable
Shiny bindings for Widget_BarChart
Widget_BarChart() stable
Bar Chart Widget
Widget_FlagOverTimeOutput() renderWidget_FlagOverTime() stable
Shiny bindings for Widget_FlagOverTime
Widget_FlagOverTime() stable
Flag Over Time Widget
Widget_GroupOverviewOutput() renderWidget_GroupOverview() stable
Shiny bindings for Widget_GroupOverview
Widget_GroupOverview() stable
Group Overview Widget
Widget_ScatterPlotOutput() renderWidget_ScatterPlot() stable
Shiny bindings for Widget_ScatterPlot
Widget_ScatterPlot() stable
Scatter Plot Widget
Widget_TimeSeriesOutput() renderWidget_TimeSeries() stable
Shiny bindings for Widget_TimeSeries
Widget_TimeSeries() stable
Time Series Widget
Analyze_NormalApprox_PredictBounds() stable
Funnel Plot Analysis with Normal Approximation - Predicted Boundaries.
Analyze_Poisson_PredictBounds() stable
Poisson Analysis - Predicted Boundaries.

Analyze

Conduct statistical analysis based on input data

Analyze_NormalApprox() stable
Funnel Plot Analysis with Normal Approximation for Binary and Rate Outcomes.
Analyze_Identity() stable
Identity Analysis.
Analyze_Fisher() stable
Fisher's Exact Test Analysis.
Analyze_Poisson() stable
Poisson Analysis - Site Residuals.

Data Pipeline

Create site-level summary, analyzed, and flagged data for an assessment

Input_Rate() stable
Input_Rate
Transform_Count() stable
Transform Count
Transform_Rate() stable
Transform Rate
Flag() stable
Flag
Flag_NormalApprox() stable
Flag_NormalApprox
Flag_Poisson() stable
Flag_Poisson
Summarize() stable
Make Summary Data Frame

Reporting

Creates summary tables and HTML objects to create a report

Report_FlagOverTime() stable
Summarize flags by SnapshotDate
Report_FormatFlag() stable
KRI Directionality Logo.
Report_KRI() stable
Report_KRI function
Report_MetricCharts() stable
Render charts for a given metric to markdown
Report_MetricTable() stable
Generate a summary table for a report
Report_StudyInfo() stable
Report Study Information

Utility

Utility functions for use within the Data Model

ApplySpec() stable
Apply Data Specification
BindResults() stable
Helper function to bind results from multiple workflows
cli_fmt()
cli style console appender for gsm
CalculatePercentage()
Helper function to compile "long" group metadata
CheckSpec() stable
Check if the data and spec are compatible
CombineSpecs()
Combine Multiple Specifications
FilterByLatestSnapshotDate()
Filter by Latest Snapshot Date
FilterByFlags()
Filter out non-flagged rows on FlagOverTime Widget
GetStrFunctionIfNamespaced() experimental
GetFunctionIfNamespaced
Ingest()
Ingests data from a source based on a given specification.
LogMessage()
Custom logging function that wraps cli messaging
MakeBounds() stable
Calculate Bounds for display in scatterplots
MakeCharts() stable
Helper function to create charts for multiple metrics
MakeMetric() stable
Parse metadata from workflows to a data frame
MakeMetricTable() stable
Generate a Summary data.frame for use in reports
MakeLongMeta() stable
Helper function to compile "long" group metadata
MakeParamLabels() MakeParamLabelsList() stable
Create Labels for Parameters
MakeStudyInfo() stable
Generate a study information data.frame for use in reports
MakeWideGroups() stable
Helper function to compile "wide" group metadata
MakeWorkflowList() stable
Load workflows from a package/directory.
ParseThreshold() stable
Parse a string into a numeric vector
RenderRmd()
Custom Rmarkdown render function
RunStep() stable
Run a single step in a workflow.
RunQuery() stable
Run a SQL query on a data frame or DuckDB table
RunWorkflow() stable
Run a workflow via it's YAML specification.
RunWorkflows() stable
Convenience function to easily run multiple workflows
SetLogger()
set the default package logger
stop_if()
Custom stop message
UseClindata() stable
UseClindata Function

Sample Data

data used for examples and testing

analyticsInput stable
analyticsInput Dataset
analyticsSummary stable
analyticsSummary Dataset
reportingBounds stable
reportingBounds Dataset
reportingGroups stable
reportingGroups Dataset
reportingMetrics stable
reportingMetrics Dataset
reportingResults stable
reportingResults Dataset
reportingBounds_country stable
reportingBounds_country Dataset
reportingGroups_country stable
reportingGroups_country Dataset
reportingMetrics_country stable
reportingMetrics_country Dataset
reportingResults_country stable
reportingResults_country Dataset