Skip to content

Switch Plot Package from TLF to OSPSuite.plots #1369

Description

@KatrinCoboeken

Summary

This package currently contains three workflows: QualificationWorkflow, MeanModelWorkflow, and PopulationWorkflow.

  • MeanModelWorkflow and PopulationWorkflow will be migrated to the ospsuite reporting framework (package: ospsuite.ReportingFramework). For these two workflows we need proper lifecycle management including a reliable stop operation.
  • QualificationWorkflow currently uses plots based on TLF. All these plots must be replaced by equivalents from ospsuite.plots. Some plot functions live in ospsuite-R and call TLF internally; those helpers must replaced to use the ospsuite-R plotfunction which use ospsuite.plots.

Goals

  • Add lifecycle management with a stop action for MeanModelWorkflow and PopulationWorkflow.
  • Replace all TLF-based plots used by QualificationWorkflow with ospsuite.plots equivalents.
  • Replace plot helper functions in ospsuite-R that depend on TLF so they use ospsuite.plots.
  • Provide tests and documentation for the changes.

Scope

  • Replace plotting code only for QualificationWorkflow (no change to the workflow logic unless required to support new plotting API).
  • Implement lifecycle stop in MeanModelWorkflow and PopulationWorkflow so they can be cleanly halted when replaced by ospsuite reporting.
  • Update helper functions in ospsuite.R used by other parts of the package.

Tasks (checklist)

  • Implement a safe stop operation that halts in-progress computation and releases resources
  • Add unit/integration tests for stop (simulate long-running tasks, resource cleanup)
  • Add lifecycle management to PopulationWorkflow
    • Implement stop operation and tests (same as above)
  • Inventory all plots in QualificationWorkflow that call TLF
    • Create a list mapping current TLF calls to ospsuite.plots equivalents (or required transformations)
  • Update ospsuite.R helper plot functions
    • Replace internal TLF calls with ospsuite.plots or refactor to delegate to ospsuite.plots
    • Update signatures and callers if necessary; ensure backward compatibility where practical
    • Add unit tests for helpers
  • Replace TLF calls in QualificationWorkflow plots with ospsuite.plots
    • Preserve plot semantics (titles, labels, legends) or document differences
    • Add/adjust tests to confirm rendering & data correctness
  • Documentation & migration notes
    • Update README/docs to state that MeanModelWorkflow and PopulationWorkflow are handled via the ospsuite reporting framework and support lifecycle stop
    • Document that QualificationWorkflow now uses ospsuite.plots

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Fields

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions