Add support for central CLI and extra_config parameter configuration#629
Merged
Conversation
Daniel-VM
added a commit
to Daniel-VM/relecov-tools
that referenced
this pull request
Jun 3, 2025
Daniel-VM
marked this pull request as ready for review
June 9, 2025 13:59
saramonzon
reviewed
Jun 9, 2025
saramonzon
approved these changes
Jun 10, 2025
Daniel-VM
added a commit
that referenced
this pull request
Jun 10, 2025
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
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.
PR Checklist
black and flake8).CHANGELOG.mdis updated.README.mdis updated (including new tool citations and authors/contributors).PR description
This PR introduces a unified and consistent approach to argument handling across all modules in relecov-tools.
Main changes:
Parameters renamed or standardized (by module):
1. Download Module (download_files)
Before: output_location
Now: output_dir
New aliases: --output-dir, --output_folder, --out-folder, --output_location, --output_path, --out_dir, --output
**2. Read Lab Metadata **
Before: metadata_out
Now: output_dir
New aliases as above
3. Validate
Before: out_folder
Now: output_dir
New aliases as above
4. send_report
Before: validate-file, receiver-email, email-psswd
Now: validate_file, receiver_email, email_psswd, additional_notes
5. Schema Mapping (map)
Before: json_data, output
Now: json_file, output_dir
New aliases for output
6. Upload to ENA (upload_to_ena)
Before: output_path
Now: output_dir
New aliases for output
7. Upload to GISAID (upload_to_gisaid)
Before: output_path
Now: output_dir
New aliases for output
8. Database Update (update_db)
Before: Arguments were passed positionally
Now: All arguments are passed as a dictionary using merge_with_extra_config (argument names are now consistent)
9. Read Bioinfo Metadata (read_bioinfo_metadata)
Before: out_dir
Now: output_dir
New aliases for output
10. Metadata Homogeneizer (metadata_homogeneizer)
Before: output
Now: output_dir
New aliases for output
11. Pipeline Manager (pipeline_manager)
Before: output
Now: output_dir
New aliases for output
12. Schema Builder (build_schema)
Before: out_dir
Now: output_dir
New aliases for output
13. Logs to Excel (logs_to_excel)
Before: output_folder
Now: output_dir
New aliases for output
14. Wrapper (wrapper)
Before: output_folder
Now: output_dir
New aliases for output
15. Upload Results (upload_results)
Before: No apparent changes in parameter names, but now uses the argument merging logic.
General summary of changes:
A full round of testing is required for all modules, as some parameter names have changed and strict consistency is now enforced.
When updating your configuration files, always use the internal parameter names (e.g., output_dir, metadata_file, etc.) as shown in initial_config.yaml.
Closes #523