fix: Update cardio-analysis command to use --N-slice flag in documentation#29
Merged
JosephBrunet merged 2 commits intoJosephBrunet:mainfrom Feb 27, 2026
Merged
fix: Update cardio-analysis command to use --N-slice flag in documentation#29JosephBrunet merged 2 commits intoJosephBrunet:mainfrom
JosephBrunet merged 2 commits intoJosephBrunet:mainfrom
Conversation
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #27
This PR updates the documentation to correctly use the
--N-sliceflag for thecardio-analysiscommand, as pointed out in issue #27.Changes
cardio-analysis ./parameters_example.conf 150tocardio-analysis ./parameters_example.conf --N-slice 150cardio-analysis ./parameters_example.conf 150tocardio-analysis ./parameters_example.conf --N-slice 150Rationale
As mentioned in issue #27, the original command
cardio-analysis ./parameters_example.conf 150does not work as expected. The tool requires the--N-sliceflag to specify the slice number, not a positional argument.Testing
The updated command follows the usage message from
cardio-analysisand should now work correctly.Checklist