Modules
Modules are the analytical engine of FASTR. Each module runs R scripts that process your project’s data - calculating indicators, detecting outliers, generating coverage estimates, or performing other statistical analyses. The results become metrics that power your visualizations and reports. Modules are configured at the instance level through results packages, which are then read by slide decks and reports.
Understanding module architecture
Section titled “Understanding module architecture”A module has two parts. The compute definition contains the R scripts that process data and produce results - these run in isolated Docker containers. The presentation definition specifies which metrics the module produces and how they can be visualized.
Modules are included when generating a results package at the instance level. A results package bundles together the outputs of all selected modules for a chosen set of data. Every slide deck and report reads its figures from an attached results package.
Configuring module defaults
Section titled “Configuring module defaults”Instance administrators can set default parameter values that pre-fill the results package generation wizard. Navigate to Results packages at the instance level and click Module defaults. The editor shows every module that takes parameters, one at a time, in a sidebar layout. Select a module on the left to view and edit its parameters on the right.
Parameter values are set only here and apply to every results package that includes the module — they are not editable in the wizard itself. The generation wizard turns on every module the data supports; the module defaults editor no longer controls which modules are pre-selected.
A parameter whose value differs from its definition default (the module’s own default value) is marked with a badge, the default value, and a reset button that unpins it so it follows the definition again. The Reset all to definition defaults button in the header resets every parameter across every module at once. Any change or reset activates an Apply button in the header; click it to save and close, or click Cancel to close without saving.
Generating a results package
Section titled “Generating a results package”To produce module outputs, generate a new results package from the instance Results packages page. Click Generate new results package to open the wizard. The wizard walks you through three steps: selecting which data families to include (HMIS, HFA, ICEH equity data), choosing which modules to run, and confirming the label.
The wizard is an ephemeral modal — nothing is saved to the server before you click Launch generation. The entire configuration (data family selections, module choices, and label) is submitted in a single step. If you close the wizard before launching, nothing is stored.
After you click Launch generation, the new package’s page opens automatically once the SSE notification arrives. You can leave the page and follow progress on the Results packages surface.

Step 1 — Choose data
Section titled “Step 1 — Choose data”Select which data families this results package is generated from. Each included family is captured in full. Only families that have data uploaded to the instance are available for selection. The wizard turns on every available family by default. If a DHIS2 import is currently running, HMIS data is temporarily unavailable and a note explains why — you must wait for the import to finish before generating a package that includes HMIS data.
Step 2 — Configure modules
Section titled “Step 2 — Configure modules”Choose which modules to run. The selection list shows every available module organised by data family, with primary modules first and supporting analyses beneath them. The wizard pre-selects every module that the chosen data can run. Select a module by checking its box. Selecting a module automatically includes all modules it depends on; a module cannot be unchecked while another selected module depends on it. Modules that require data families not chosen in step 1 are shown as unavailable, with a note naming which family is missing so you can go back to step 1 and add it.
If any selected module has parameter values stored in the module defaults that fail validation, those module names are listed below the selection with a prompt to fix them in Module defaults before launching. Parameter values are not editable in the wizard.
Available modules include:
- Disruption detection — detects service disruptions using a Negative Binomial Bayesian model. Produces observed, expected, lower bound, and upper bound series that power the Bayesian disruptions chart. Requires the data quality adjustments module as a prerequisite.
- Coverage estimates — computes coverage estimates. Requires the coverage denominators module as a prerequisite.
- Service utilization — computes derived common indicator values by applying each indicator’s formula to the summed ingredients from the HMIS extract. Requires the data quality adjustments module as a prerequisite. When population terms are used in indicator formulas, this module uses person-years data from the population store; areas and months not covered by the population store are dropped for those indicators.
Step 3 — Confirm and launch
Section titled “Step 3 — Confirm and launch”Enter a label for the results package and review the data and module selections. The wizard suggests a label based on the current date. Click Launch generation to start.
Results packages catalogue
Section titled “Results packages catalogue”The Results packages catalogue lists every package generated for the instance. Each row shows the package label along with what the package contains — the data families it captured (such as HMIS, HFA, or ICEH) and how many modules it includes — so you can tell packages apart at a glance without opening each one. The row also shows the date the package was created and whether it is the pinned package.
When you use the package picker in a slide deck, report, or project, each package option likewise shows its label, data families, and module count alongside the creation date and pinned status.
Population data and indicator values
Section titled “Population data and indicator values”When one or more indicator formulas reference a population term, the service utilization module requires population data to be imported at the instance level before generation. The generation will fail if population data is referenced but not present for any area of the current HMIS structure at the configured population level.
The population level must be set on the instance Population page and must not be deeper than the HMIS structure’s admin area depth. If the population level is deeper than the structure, generation fails with a clear message explaining the mismatch.
For areas and months where population data exists, the module computes the indicator. For areas or months where the population store has no coverage, the module drops those cells for population-dependent indicators rather than failing the whole generation. The results package records which population types were active and what coverage was achieved.
Deleting results packages in bulk
Section titled “Deleting results packages in bulk”As you generate packages over time, old ones accumulate. Select the packages you no longer need in the Results packages table and use the Delete bulk action. The guard checks each package in turn — packages that are pinned, still generating, or attached to a product are refused with the reason shown, while the rest are deleted. Nothing is refetched after each deletion; the list shrinks live as each package is removed.
Pinning a results package
Section titled “Pinning a results package”Administrators can designate one ready package as the instance’s pinned package. New slide decks and reports start on the pinned package. Existing products keep their own package unless an editor manually switches them. To pin a package, open its detail view on the Results packages page and click Pin. To unpin, click Unpin on the currently pinned package.
The pinned package is also the package the FASTR MCP connector reads. When you connect a compatible AI client to your instance’s MCP endpoint, it reads metrics and data from whichever package is currently pinned.
Scopes
Section titled “Scopes”A scope sets which part of a results package a slide deck or report may show — for example one region, certain years, or certain modules and indicators. Every approved user sees the Scopes tab in the main navigation. Unrestricted users (those with access to all data) can create, edit, and delete scopes; a restricted user can view the scopes they hold but cannot write them. The scope called All data is always present and limits nothing; it is displayed as a fixed panel above the scopes table rather than as a row within it. On the Users page, a user can also be limited to certain scopes so they see only products that use those scopes.
Module execution and status
Section titled “Module execution and status”Each module in a results package displays its current generation status:
- Ready means results are available. You’ll see timestamps and which data and parameter versions produced the output.
- Running indicates the module is currently generating. Progress messages show which step is executing.
- Error signals something went wrong during generation.
Once a package is fully generated its status is shown on the results packages catalogue page. Opening a package from the catalogue shows a status bar with the generation progress, the run time, module chips grouped by data family for a ready package, the live R output line while a script is running, which products use the package, and the population stamp if applicable. Click any module chip (except those still pending) to open that module’s logs in a modal, where a Refresh button re-reads the log while the package is still generating.

Viewing logs and diagnostics
Section titled “Viewing logs and diagnostics”When a module errors or produces unexpected results, check the logs from the results package detail view. Access Logs to see R console output, warnings, errors, and timing information. You can also click a module’s chip in the status bar to open its logs directly in a modal.
For complex issues, view Script to see the exact R code that ran. The Files option shows data files the module produced, useful for manual inspection of intermediate results.
Script, file, and log access all require the View data permission. These permissions apply whether you are browsing from the instance catalogue or from a product’s Results package tab.
Deleting results packages
Section titled “Deleting results packages”To remove a results package, open it from the instance results packages catalogue and click Delete. FASTR refuses to delete a package while any product is using it, while it is pinned, or while it is still generating. The detail view explains the reason when deletion is blocked. Deletion permanently removes the package’s files and cached results and cannot be undone.