Skip to content

Potential Future Improvements #91

@Joanneylin

Description

@Joanneylin

🔍 Suggestions if you’re considering using or adapting it

  • Add a detailed setup guide: include database schema access steps, environment variables, dependencies (R packages + versions).
  • Introduce unit tests and UI tests (via shinytest or similar) for key modules to ensure changes don’t break cleaning workflows.
  • Consider refactoring large script files into smaller, well-documented functions. Ensure modules have minimal side-effects and are reusable.
  • Create sample/mock data so new developers or users can run the app locally without needing full production data access (you might already have internal solutions).
  • If more than one person will maintain it, use code style guidelines, linting (e.g., lintr), and maybe a pre-commit check for style consistency.
  • Add performance monitoring/logging inside the Shiny app (e.g., measure how long key cleaning steps take) so you can identify bottlenecks as the dataset grows.
  • Consider versioning/releases (even internal) to allow users to pin to a stable version.
  • If you plan to open the tool wider (e.g., beyond PSRC), add a CONTRIBUTING.md and issue templates so external contributors know how to help.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions