-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Blobdetect lc #15
Open
Karl5766
wants to merge
2
commits into
main
Choose a base branch
from
blobdetect-lc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Blobdetect lc #15
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,43 @@ | ||
## Core command-line interface | ||
## The `spimquant` Interface | ||
|
||
The spimquant tool command-line interface is a composition of the core | ||
(app-based) arguments and options, and the options related to Snakemake. | ||
|
||
As an end user, command line interface (CLI) is recommended as a way to specify | ||
the input/output data paths and configuration settings. The arguments passed | ||
in this way will be used to overwrite some of the default options defined in | ||
the config file `spimquant/config/snakebids.yml` and adapt to different datasets. | ||
|
||
Underlying SPIMquant, we use `snakemake` to manage workflow and config file. | ||
`spimquant` is a program that writes to the config file, and supports | ||
all Snakemake arguments. | ||
|
||
Steps to run a typical job looks like the following: | ||
```bash | ||
spimquant bids_dir output_dir {participant} [snakemake_args] | ||
# now since we run spimquant, contents in config/snakebids.yml has changed | ||
# and we can run snakemake with the updated configuration | ||
snakemake result_file_path | ||
``` | ||
All three arguments above to `spimquant` are not optional but necessary. | ||
The above first command will do the following: | ||
1. Log the configuration used to run snakemake in the location output_dir, | ||
including the snakebids.yml file and logs. | ||
2. Pass bids_dir over to overwrite the bids_dir defined in the default | ||
snakebids.yml. | ||
3. Start snakemake using the snakemake_args provided | ||
|
||
A more concrete example: | ||
```bash | ||
spimquant test_bids_dir test_out participant | ||
snakemake results/result_image.nii -n | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can specify targets using the spimquant cli too.. e.g. spimquant test_bids_dir test_out participant -n results/result_image.nii So there isn't a need to instruct the user to run snakemake directly.. |
||
``` | ||
Here we use -n so you can run this command but snakemake will only output a | ||
plan without generating any file. In an actual run, you can use `--cores all` | ||
to specify to use all cores and `--use-apptainer` to download and use existing | ||
container image for SPIMquant that have already installed all dependencies, | ||
without having to set up the environment yourself. | ||
|
||
The core BIDS App arguments and app-specific options are listed below. | ||
|
||
|
||
|
This file contains 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
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure why you need this -- the spimquant cli runs snakemake already --