Skip to content

Update documentation to use pipeline workflow as primary approach #288

@sbfnk

Description

@sbfnk

Summary

The new pipeline workflow (assign_age_groups()weigh()compute_matrix()symmetrise()/split_matrix()/per_capita()) provides a cleaner, more modular approach to computing contact matrices.

The documentation (README and vignettes) should be updated to present this as the primary/recommended approach, with contact_matrix() mentioned as a convenience wrapper for simple cases or legacy compatibility.

Tasks

  • Update README.md examples to showcase the pipeline workflow
  • Update the vignette to use the pipeline approach as the main tutorial
  • Add documentation explaining when to use the pipeline vs contact_matrix()

Related to #161, #287

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions