-
Notifications
You must be signed in to change notification settings - Fork 501
FastGA Aligner #7666
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
base: main
Are you sure you want to change the base?
FastGA Aligner #7666
Conversation
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.
@as042 Some preliminary comments inline. Please also add the missing .shed.yml file.
tools/fastga/fastga.xml
Outdated
| @@ -0,0 +1,99 @@ | |||
| <tool id="fastga" name="FastGA" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" python_template_version="3.5" profile="21.05"> | |||
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.
| <tool id="fastga" name="FastGA" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" python_template_version="3.5" profile="21.05"> | |
| <tool id="fastga" name="FastGA" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@"> |
@Profile@ token can be introduced here
tools/fastga/fastga.xml
Outdated
| @@ -0,0 +1,99 @@ | |||
| <tool id="fastga" name="FastGA" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" python_template_version="3.5" profile="21.05"> | |||
| <description>: align long sequences</description> | |||
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.
| <description>: align long sequences</description> | |
| <description>align long sequences</description> |
tools/fastga/fastga.xml
Outdated
| <requirements> | ||
| <requirement type="package" version="@TOOL_VERSION@">fastga</requirement> | ||
| </requirements> |
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.
This can go to macros
tools/fastga/fastga.xml
Outdated
| </data> | ||
| </outputs> | ||
| <tests> | ||
| <test> |
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.
| <test> | |
| <test expect_num_outputs="1"> |
tools/fastga/fastga.xml
Outdated
| <param name="output_format" value="paf"/> | ||
| <output name="output1" file="chrM_HGvMM.paf"/> | ||
| </test> | ||
| <test> |
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.
| <test> | |
| <test expect_num_outputs="1"> |
tools/fastga/fastga.xml
Outdated
| <param name="input1" value="chrM_hg38.fa.gz"/> | ||
| <param name="input2" value="chrM_mm39.fa.gz"/> | ||
| <param name="output_format" value="paf"/> | ||
| <output name="output1" file="chrM_HGvMM.paf"/> |
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.
Can we also check the ftype here?
tools/fastga/fastga.xml
Outdated
| <param name="input1" value="chrM_hg38.fa.gz"/> | ||
| <param name="input2" value="chrM_mm39.fa.gz"/> | ||
| <param name="output_format" value="psl"/> | ||
| <output name="output1" file="chrM_HGvMM.psl"/> |
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.
ftype?
| @@ -0,0 +1,4 @@ | |||
| <macros> | |||
| <token name="@TOOL_VERSION@">1.3.1</token> | |||
| <token name="@VERSION_SUFFIX@">0</token> | |||
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.
| <token name="@VERSION_SUFFIX@">0</token> | |
| <token name="@VERSION_SUFFIX@">0</token> | |
| <token name="@PROFILE@">25.0</token> |
| -v: Verbose mode, output statistics as proceed. | ||
| -k: Keep any generated .1gdb's and .gix's. | ||
| -M: Use soft mask information if available. | ||
| -S: Use symmetric seeding (not recommended). | ||
| -L: Output log to specified file. | ||
| -T: Number of threads to use. | ||
| -P: Directory to use for temporary files. | ||
|
|
||
| -paf: Stream PAF output | ||
| -pafx: Stream PAF output with CIGAR string with X's | ||
| -pafm: Stream PAF output with CIGAR string with ='s | ||
| -pafs: Stream PAF output with CS string in short form | ||
| -pafS: Stream PAF output with CS string in long form | ||
| -psl: Stream PSL output | ||
| -1: Generate 1-code output to specified file | ||
|
|
||
| -f: adaptive seed count cutoff | ||
| -c: minimum seed chain coverage in both genomes | ||
| -s: threshold for starting a new seed chain | ||
| -l: minimum alignment length | ||
| -i: minimum alignment identity | ||
| -S: seed adaptamers from both genomes |
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.
I think many of these parameters are not part of the wrapper. Do you plan to include them? If not, this can be removed. More help about input, outputs and what the tool does could be beneficial here.
tools/fastga/fastga.xml
Outdated
| <citations> | ||
| <citation type="bibtex"> | ||
| @misc{githubFASTGA, | ||
| author = {Gene Myers and Chenxi Zhou}, | ||
| year = {2025}, | ||
| title = {FASTGA}, | ||
| publisher = {GitHub}, | ||
| journal = {GitHub repository}, | ||
| url = {https://github.com/thegenemyers/FASTGA}, | ||
| }</citation> | ||
| </citations> |
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.
This can also go to macros
I just want to push my changes, and git says I have to pull to do that first.
| <command detect_errors="exit_code"><![CDATA[ | ||
| ## FastGA directly string matches the file extensions | ||
| ## symlinks are used to bypass that restriction | ||
| ln -s "$input1" "input1.${input1.ext}" && |
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.
Please use single quotes
| ln -s "$input1" "input1.${input1.ext}" && | ||
| ln -s "$input2" "input2.${input2.ext}" && | ||
| FastGA | ||
| #if str( $output_format ) == "paf": |
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.
You could just $output_format and use -paf and -psl as values of the select
| "input1.${input1.ext}" "input2.${input2.ext}" > output | ||
| ]]></command> | ||
| <inputs> | ||
| <param type="data" name="input1" format="gix,1gdb,fa,fna,fasta,fa.gz,fna.gz,fasta.gz,1seq"/> |
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.
It's just fasta and fasta.gz.
Eher are gix, 1gdb and 1seq?
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.
Please add label to inputs
| <inputs> | ||
| <param type="data" name="input1" format="gix,1gdb,fa,fna,fasta,fa.gz,fna.gz,fasta.gz,1seq"/> | ||
| <param type="data" name="input2" format="gix,1gdb,fa,fna,fasta,fa.gz,fna.gz,fasta.gz,1seq"/> | ||
| <param name="output_format" type="select" display="radio" label="Specify the output format"> |
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.
Avoid radio
FOR CONTRIBUTOR:
There are two labels that allow to ignore specific (false positive) tool linter errors:
skip-version-check: Use it if only a subset of the tools has been updated in a suite.skip-url-check: Use it if github CI sees 403 errors, but the URLs work.