βeta3
Pre-release
Pre-release
Changes from Previous Release (βeta2):
(1) New gene annotation pipeline (VADR) integrated into Nextflow wrapper:
- Can be accessed through both the main workflow (using the
run_vadrparameter) and as a separate entrypoint - VADR is restricted to only running through Docker, as the docker container is being pulled from the StaphB DockerHub (VADR Container). The actual docker container is specified via a new parameter:
docker_container_vadr - If both Liftoff and VADR gene annotation are toggled on, for the main workflow, they will run in parallel during their respective processes and through the submission portion of the pipeline. VADR will output files in the directory defined by the
vadr_output_dirparameter - Necessary MPXV model files for reference have been added to the repository, therefore no additional setup is required. A new parameter named
vadr_models_dirhas been added to encode the location of these model files
(2) New templates for opening an issue have been added:
- bug related and opened by a maintainer/collaborator
- feature related and opened by a maintainer/collaborator
- bug related and opened by a user
- feature related and opened by a user
The various options can be found here: Issues Tab
(3) Updates to the pull-request template:
- custom checklist
- CDC specific criteria (for maintainers/collaborators)
(4) README.md has had multiple changes including:
- all information about VADR including where to find accompanying documentation for this package and the parameters mentioned above
- general ordering with certain sections have been switched or change
- information added in the setup section to include steps for provisioning a Scicomp (HPC Cluster at the CDC) environment to run the pipeline
- certain pieces of information have been made present or more obvious within the quick-start and running the pipeline sections (wait time, setting up your submission configuration file, etc.)
- more information has been added to explain required parameters/inputs for the submission entrypoints
(5) Test files (.yaml and .json) have been created within the nf_params directory
Autogenerated Release Notes:
- Template for Git Issues by @ankushkgupta2 in #12
- New Issue Templates + Default Labels and Titles - Issue #18 by @ankushkgupta2 in #19
- README.md Improvements (Issue #26) by @ankushkgupta2 in #30
- Residual README.md Changes From PR #30 (Root: Issue #26) by @ankushkgupta2 in #31
- VADR Annotation Integration by @ankushkgupta2 in #28
- Updates to Issue / PR Temps by @ankushkgupta2 in #24
- Maintainer Contact + Issue Request Information by @ankushkgupta2 in #23
- Patch for VADR Enhancement and Parameter Check Changes by @ankushkgupta2 in #32
Full Changelog: v1.0.0-beta...v2.0.0-beta