Skip to content

39 add option to skip step or group of steps#55

Merged
rpahl merged 6 commits intomainfrom
39-add-option-to-skip-step-or-group-of-steps
Dec 14, 2025
Merged

39 add option to skip step or group of steps#55
rpahl merged 6 commits intomainfrom
39-add-option-to-skip-step-or-group-of-steps

Conversation

@rpahl
Copy link
Owner

@rpahl rpahl commented Dec 14, 2025

This pull request introduces several updates and cleanups to the pipeline API, focusing on simplifying the output collection, removing legacy options, and adding new functionality for skipping steps and groups. The most important changes are summarized below.

Output Collection and API Simplification

  • The pipe_collect_out() function and its documentation have been updated: the all parameter (which collected all outputs regardless of the keepOut flag) has been removed, and only non-skipped steps are now included in the output. The documentation has been revised for clarity, and examples have been updated accordingly. [1] [2] [3] [4] [5] [6]
  • The pipe_set_data_split() and pipe_set_keep_out() functions have been removed, along with their documentation and examples, as part of a cleanup to simplify the API and focus on core functionality. [1] [2]

Step and Group Skipping Functionality

  • New functions have been added to skip and unskip pipeline steps and groups: pipe_skip_step(), pipe_unskip_step(), pipe_skip_group(), and pipe_unskip_group(). These allow users to exclude certain steps or groups from execution and output collection, with full documentation and examples. [1] [2]

Removal of Deprecated or Redundant Exports

  • The following exports have been removed from NAMESPACE and the codebase: pipe_has_step_locked, pipe_set_data_split, and pipe_set_keep_out, reflecting their removal from the API. [1] [2] [3] [4] [5]

New Utility Function

  • A new function, pipe_get_step_field(), has been added to retrieve a specific field of a pipeline step, with corresponding documentation. [1] [2]

Documentation and Minor Updates

  • Documentation has been updated throughout to reflect API changes, improve clarity, and ensure consistency with the revised functions and parameters. This includes updates to .Rbuildignore and minor title changes. [1] [2] [3] [4] [5]

These changes modernize and clarify the pipeline API, making it easier to use and maintain.

- Updated tests to ensure output collection behaves as expected, removing unnecessary `all = TRUE` parameters.
- Enhanced the handling of `keepOut` parameter in various steps to ensure proper output retention.
- Introduced new tests for `skip_group` and `unskip_group` functionalities, ensuring they correctly manage step states and skip flags.
- Removed redundant tests related to cleaning unkept steps and adjusted assertions to reflect current functionality.
- Added tests for `get_step_field` to validate retrieval of specific fields from pipeline steps.
- Improved overall test readability and structure for better maintainability.
@rpahl rpahl linked an issue Dec 14, 2025 that may be closed by this pull request
@rpahl rpahl merged commit fdc8b77 into main Dec 14, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add option to skip step or group of steps

1 participant