Skip to content

[Feature Request]: Ensure picks migration has consistent design patterns #340

Description

@osenan

Feature description

This is a follow up to the task #330 in order to verify, check and change if necessary all implementations on the migration to teal.picks so we ensure consistent design patterns across documentation, functionality, input validation and other.

This issue is to be tested on the feature branch before it is merged to main

Please verify the following list:

Documentation

  • All migrated module argument documentation follow the same documentation pattern if they are equivalent
  • Update argument_convention.R file, check for exceptions in modules.
  • Examples do not use prefix for teal.picks objects

Code

  • Input validation is implemented (when possible) using teal validate functions
  • Big chunks of input validation will have their own separated qenv validated_q when possible
  • We use package helper functions to convert from teal.transform and create picks
  • We avoid user to define picks and try to use teal.picks::variables or teal.picks::picks without dataset
  • Consistent usage of utils function to check and force specific picks not to be multiple
  • Outputs are created using within and not using teal.code::eval_code
  • Default argument value is consistent across modules

Tests

  • All tests are passed
  • Each module at least has a testServer so we verify that it can be created using teal.picks or teal.transform objects

Optional

Functionality and manual revision will be done after this is completed, on a separate issue

Code of Conduct

  • I agree to follow this project's Code of Conduct.

Contribution Guidelines

  • I agree to follow this project's Contribution Guidelines.

Security Policy

  • I agree to follow this project's Security Policy.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Fields

    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