-
Notifications
You must be signed in to change notification settings - Fork 6
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
Add agat convert minimap2 bam2gff #113
Open
Leila011
wants to merge
17
commits into
main
Choose a base branch
from
add-agat_convert_minimap2_bam2gff
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
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
6a79e7d
add help
Leila011 e033a5f
add config
Leila011 309ef68
add run script
Leila011 15692cf
add test data & expected output + script to fetch them
Leila011 3db96bd
add test
Leila011 77e7298
update changelog
Leila011 173f592
Merge main into add-agat_convert_minimap2_bam2gff
rcannood 6019ea0
Merge branch 'main' into add-agat_convert_minimap2_bam2gff
Leila011 16abedc
update config: add keyword, add requirements, --config description,...
Leila011 2360e13
add set -eo pipefail to script and test files
Leila011 23ab75c
fix indentation
Leila011 c527975
create temporary directory and clean up on exit
Leila011 5288f3f
cleanup changelog
Leila011 852f11b
PR fixes
jakubmajercik fc6c524
Merge branch 'main' into add-agat_convert_minimap2_bam2gff
jakubmajercik cfb6a20
updated requirements
jakubmajercik 86f8d75
Merge branch 'add-agat_convert_minimap2_bam2gff' of github.com:viash-…
jakubmajercik 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 |
---|---|---|
@@ -0,0 +1,75 @@ | ||
name: agat_convert_minimap2_bam2gff | ||
namespace: agat | ||
description: | | ||
Convert output from minimap2 (bam or sam) into gff file. To | ||
get bam from minimap2 use the following command: `minimap2 -ax splice:hq | ||
genome.fa Asecodes_parviclava.nucest.fa | samtools sort -O BAM -o | ||
output.bam`. | ||
keywords: [gene annotations, GFF conversion, minimap2] | ||
links: | ||
homepage: https://github.com/NBISweden/AGAT | ||
documentation: https://agat.readthedocs.io/en/latest/tools/agat_convert_minimap2_bam2gff.html | ||
issue_tracker: https://github.com/NBISweden/AGAT/issues | ||
repository: https://github.com/NBISweden/AGAT | ||
references: | ||
doi: 10.5281/zenodo.3552717 | ||
license: GPL-3.0 | ||
requirements: | ||
commands: [agat] | ||
authors: | ||
- __merge__: /src/_authors/leila_paquay.yaml | ||
roles: [ author, maintainer ] | ||
argument_groups: | ||
- name: Inputs | ||
arguments: | ||
- name: --input | ||
alternatives: [-i] | ||
description: Input file in SAM (.sam extension) or BAM (.bam extension) format. | ||
type: file | ||
required: true | ||
direction: input | ||
example: input.sam | ||
- name: Outputs | ||
arguments: | ||
- name: --output | ||
alternatives: [-o, --out] | ||
description: Output GFF file. | ||
type: file | ||
direction: output | ||
required: true | ||
example: output.gff | ||
- name: Arguments | ||
arguments: | ||
- name: --bam | ||
alternatives: [-b] | ||
description: To force the use of the input file as a BAM file. | ||
type: boolean_true | ||
- name: --sam | ||
alternatives: [-s] | ||
description: To force the use of the input file as a SAM file. | ||
type: boolean_true | ||
- name: --config | ||
alternatives: [-c] | ||
description: | | ||
AGAT config file. By default AGAT takes the original agat_config.yaml shipped with AGAT. The `--config` option gives you the possibility to use your own AGAT config file (located elsewhere or named differently). | ||
type: file | ||
required: false | ||
example: custom_agat_config.yaml | ||
resources: | ||
- type: bash_script | ||
path: script.sh | ||
test_resources: | ||
- type: bash_script | ||
path: test.sh | ||
- type: file | ||
path: test_data | ||
engines: | ||
- type: docker | ||
image: quay.io/biocontainers/agat:1.4.0--pl5321hdfd78af_0 | ||
setup: | ||
- type: docker | ||
run: | | ||
agat --version | sed 's/AGAT\s\(.*\)/agat: "\1"/' > /var/software_versions.txt | ||
runners: | ||
- type: executable | ||
- type: nextflow |
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 |
---|---|---|
@@ -0,0 +1,76 @@ | ||
```sh | ||
agat_convert_minimap2_bam2gff.pl --help | ||
``` | ||
|
||
------------------------------------------------------------------------------ | ||
| Another GFF Analysis Toolkit (AGAT) - Version: v1.4.0 | | ||
| https://github.com/NBISweden/AGAT | | ||
| National Bioinformatics Infrastructure Sweden (NBIS) - www.nbis.se | | ||
------------------------------------------------------------------------------ | ||
|
||
|
||
Name: | ||
agat_convert_minimap2_bam2gff.pl | ||
|
||
Description: | ||
The script converts output from minimap2 (bam or sam) into gff file. To | ||
get bam from minimap2 use the following command: minimap2 -ax splice:hq | ||
genome.fa Asecodes_parviclava.nucest.fa | samtools sort -O BAM -o | ||
output.bam To use bam with this script you will need samtools in your | ||
path. | ||
|
||
Usage: | ||
agat_convert_minimap2_bam2gff.pl -i infile.bam [ -o outfile ] | ||
agat_convert_minimap2_bam2gff.pl -i infile.sam [ -o outfile ] | ||
agat_convert_minimap2_bam2gff.pl --help | ||
|
||
Options: | ||
if ( !GetOptions( 'i|input=s' => \$opt_in, | ||
|
||
-i or --input | ||
Input file in sam (.sam extension) or bam (.bam extension) | ||
format. | ||
|
||
-b or --bam | ||
To force to use the input file as sam file. | ||
|
||
-s or --sam | ||
To force to use the input file as sam file. | ||
|
||
-o, --out or --output | ||
Output GFF file. If no output file is specified, the output will | ||
be written to STDOUT. | ||
|
||
-c or --config | ||
String - Input agat config file. By default AGAT takes as input | ||
agat_config.yaml file from the working directory if any, | ||
otherwise it takes the orignal agat_config.yaml shipped with | ||
AGAT. To get the agat_config.yaml locally type: "agat config | ||
--expose". The --config option gives you the possibility to use | ||
your own AGAT config file (located elsewhere or named | ||
differently). | ||
|
||
-h or --help | ||
Display this helpful text. | ||
|
||
Feedback: | ||
Did you find a bug?: | ||
Do not hesitate to report bugs to help us keep track of the bugs and | ||
their resolution. Please use the GitHub issue tracking system available | ||
at this address: | ||
|
||
https://github.com/NBISweden/AGAT/issues | ||
|
||
Ensure that the bug was not already reported by searching under Issues. | ||
If you're unable to find an (open) issue addressing the problem, open a new one. | ||
Try as much as possible to include in the issue when relevant: | ||
- a clear description, | ||
- as much relevant information as possible, | ||
- the command used, | ||
- a data sample, | ||
- an explanation of the expected behaviour that is not occurring. | ||
|
||
Do you want to contribute?: | ||
You are very welcome, visit this address for the Contributing | ||
guidelines: | ||
https://github.com/NBISweden/AGAT/blob/master/CONTRIBUTING.md |
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 |
---|---|---|
@@ -0,0 +1,18 @@ | ||
#!/bin/bash | ||
|
||
set -eo pipefail | ||
|
||
## VIASH START | ||
## VIASH END | ||
|
||
# unset flags | ||
[[ "$par_bam" == "false" ]] && unset par_bam | ||
[[ "$par_sam" == "false" ]] && unset par_sam | ||
|
||
# run agat_convert_sp_bed2gff.pl | ||
agat_convert_minimap2_bam2gff.pl \ | ||
--input "$par_input" \ | ||
--output "$par_output" \ | ||
${par_bam:+--bam} \ | ||
${par_sam:+--sam} \ | ||
${par_config:+--config "${par_config}"} |
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 |
---|---|---|
@@ -0,0 +1,35 @@ | ||
#!/bin/bash | ||
|
||
set -eo pipefail | ||
|
||
## VIASH START | ||
## VIASH END | ||
|
||
test_dir="${meta_resources_dir}/test_data" | ||
|
||
# create temporary directory and clean up on exit | ||
TMPDIR=$(mktemp -d "$meta_temp_dir/$meta_functionality_name-XXXXXX") | ||
function clean_up { | ||
[[ -d "$TMPDIR" ]] && rm -rf "$TMPDIR" | ||
} | ||
trap clean_up EXIT | ||
|
||
echo "> Run $meta_name with test data" | ||
"$meta_executable" \ | ||
--input "$test_dir/test_minimap2.sam" \ | ||
--output "$TMPDIR/output.gff" | ||
|
||
echo ">> Checking output" | ||
[ ! -f "$TMPDIR/output.gff" ] && echo "Output file output.gff does not exist" && exit 1 | ||
|
||
echo ">> Check if output is empty" | ||
[ ! -s "$TMPDIR/output.gff" ] && echo "Output file output.gff is empty" && exit 1 | ||
|
||
echo ">> Check if output matches expected output" | ||
diff "$TMPDIR/output.gff" "$test_dir/agat_convert_minimap2_bam2gff_1.gff" | ||
if [ $? -ne 0 ]; then | ||
echo "Output file output.gff does not match expected output" | ||
exit 1 | ||
fi | ||
|
||
echo "> Test successful" |
Oops, something went wrong.
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.
Would it be better to update the docker setup so that samtools is also installed?