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.
Checklist
before non-breaking changes.
it might be sufficient to modify the existing CHANGELOG entry from previous
commit(s).
that break the api/interface). Examples: renaming the input/output, adding
mandatory input, removing input/output...
backwards-compatible manner. Examples: add output field, add non-mandatory
input parameter, use a different tool that produces same results...
the api/interface. Examples: typo fix, change/add warning messages...
Additional guidelines
Processes
only when its functionality has changed. Small parts may be changed
to fix bugs (by changing code only to make it nicer you might introduce a bug).
can be performed).
homepage and publication.
in square brackets (for example: Maximum length [
--maxlength
]).If they are provided, then
required = False
is not needed.Cmd()
for each call in the process (call of a tool, aBash command, a Python script or an R script) and handle return codes.
self.progress()
calls where appropriate.Commit and PR messages
tests).
Tests
genome_species.fa.gz
annotation_species.gtf.gz
adapters-name/type-source
.This folder should include separate subfolders for inputs and outputs.
test file to the
files/large
directory so it will be tracked with Git LFS.missing, if the length of some list is 0, if a string is given where one
expects an integer, if a file is empty, ...
of the last steps. Pick the one that is most likely to fail. Also test
that all steps have 'OK' status.