Giter Club home page Giter Club logo

gfap's Introduction

GFAP: ultrafast and accurate gene functional annotation software for plants

1 Shenzhen Branch, Guangdong Laboratory of Lingnan Modern Agriculture, Genome Analysis Laboratory of the Ministry of Agriculture and Rural Affairs, Agricultural Genomics Institute at Shenzhen, Chinese Academy of Agricultural Sciences
2State Key Laboratory of Subtropical Silviculture, College of Forestry and Biotechnology, Zhejiang A&F University
3 School of Computer and Electronic Information/School of Artificial Intelligence, Nanjing Normal University
4 State Key Laboratory of Plant Physiology and Biochemistry, College of Life Science, Zhejiang University
5 College of Forestry, Shandong Agricultural University, Tai'an
*These authors contributed equally, Corresponding Authors

paper website

a software for annotating genes, especially for annotating plant genes.

The software can be downloaded in the "Releases" module of this website. Furthermore, large amounts of toturials (including videos and manual) can also be found in this website, which can help users run GFAP without any barriers.

The source code of GFAP has been uploaded into the 'Release' module. Please note that the source code is licensed under the BSD 3-Clause "NEW" or "Revised" License.

If the source code is helpful to your researches, please cite our article. Thank you!

Contact

If you have any questions or suggestions about GFAP, please don't hesitate to contact me at [email protected].

Citation

If you find our work useful, please consider citing:

@article{10.1093/plphys/kiad393,
    author = {Xu, Dong and Yang, Yingxue and Gong, Desheng and Chen, Xiaojian and Jin, Kangming and Jiang, Heling and Yu, Wenjuan and Li, Jihong and Zhang, Jin and Pan, Weihua},
    title = "{GFAP: ultrafast and accurate gene functional annotation software for plants}",
    journal = {Plant Physiology},
    volume = {193},
    number = {3},
    pages = {1745-1748},
    year = {2023},
    doi = {10.1093/plphys/kiad393}
} 

Interface and corresponding linux commands

GO/KEGG/pfam:

annotate command 1:

pythonGFAP-linux.py
-qp/qn User input file or content
-aws user-selected content
-go/kegg/pfam (This is a multiple choice, depending on the user's selection, this will also be -go -kegg -pfam)
-am (fast or sensitive or do not set this option)
-e The value set by the user (Evalue can be set or not)
-ap The value set by the user (match-percentage can be set or not)
-only_ID (can be set or not)
-o The saved folder (if the previous one is a multi-selection, multiple result files will be generated at the same time, so it should be the path of a folder, and then all the results in this folder will be sent to the user. After the sending is completed Delete Files)

annotate command 2:

pythonGFAP-linux.py
-qp/qn User input file or content
-awd user-selected content
-go/kegg/pfam (This is a multiple choice, depending on the user's selection, this will also be -go -kegg -pfam)
-am (fast or sensitive or do not set this option)
-e The value set by the user (Evalue can be set or not)
-ap The value set by the user (match-percentage can be set or not)
-only_ID (can be set or not)
-o The saved folder (if the previous one is a multi-selection, multiple result files will be generated at the same time, so it should be the path of a folder, and then all the results in this folder will be sent to the user. After the sending is completed Delete Files)

miRNA-lncRNA:

pythonGFAP-linux.py
-na
-nt (divided into miRNA or lncRNA according to user selection)
-qn user input file
-o The saving path of the result file, which will be sent to the user after completion (you can consider deleting it after the sending is completed, which will not be described in details below).

gene families:

show members of a single family command

pythonGFAP-linux.py
-sf //single family
-qp (input file)
-mn/mp (Here you need to check whether there is a file put in mp. If there is a file put in, the parameter there is mp and the input file is added. If not, it is mn and the content selected by the user is added)
-o (save path of the result file, the processing method is the same as before)

show genes containing domains of families command

pythonGFAP-linux.py
-mf // domains of families
-atf/agf (screening for transcription factor/non-transcription factor families)
-qp (input file)
-o (save path of result file)

statistics:

pythonGFAP-linux.py
-ds //draw statistics
-ar (input file)
-cut_value (there is a default value, the user can set it or not, the same as below)
-gn (has a default value, the user can set it or not)
-drawtypes (value)
-colormodel (value)
-color (value)
-singlecolor
-st (take value)
-go/-kegg/pfam
-o (will save the results to: ./draw/)

pathway:

pythonGFAP-linux.py
-dn
-ar (input file)
-cut_value (there is a default value, the user can set it or not, the same as below)
-gn (has a default value, the user can set it or not)
-pvalue (there is a default value, the user can set it or not)
-colormodel (value)
-aws (receive value)
-st (take value)
-gca (receive value)
-go/kegg/pfam
-o (will save the results to: ./draw/)

translation:

pythonGFAP-linux.py
-t
-qn (input file)
-o (save path of result file, same as above)

RNA2DNA:

pythonGFAP-linux.py
-rd
-qn (input file)
-o (save path of result file, same as above)

extraction:

extraction command

pythonGFAP-linux.py
-ex
-ar (input file)
-ID (ID or ID file)
-exfid/exgid (choose one)
-o (save path of result file, same as above)

merge annotation results

pythonGFAP-linux.py
-mr
-qn (input file)
-rp (You need to put the previous results into an empty folder and enter the location of the folder here. Be careful not to change the file name when moving the file)
-o (save path of result file, same as above)

conversion:

pythonGFAP-linux.py
-cf
-gf (input file)
-gid (the index of the gene ID in the result file, received is an integer)
-fid (the index of go/pfam/kegg in the result file, receiving an integer)
-pvalue (the index of pvalue in the result file, receives an integer)
-o (the saving path of the result file, the processing of the results is the same as above)

gfap's People

Contributors

jerry391 avatar

Stargazers

 avatar  avatar  avatar Changchuanjun avatar Anurag Daware avatar Duanmiao Si avatar  avatar Yanren Wang avatar  avatar  avatar zhangwenda avatar xiaoliang avatar 徐超群 avatar Ruih avatar Yuan Gao avatar Yumin Huang avatar Zhang Yixing avatar  avatar LI YUNFEI avatar

Watchers

 avatar zhangwenda avatar  avatar

gfap's Issues

GFAP fails silently

Hi there,

I'm attempting to run GFAP using a few sequences at first, and all things that I attempt fail silently:
e.g:

python3 GFAP.py -go -qn test.fasta -o test_out 

I first needed to install a few python packages before it ran, but once I installed them there are no error messages, regardless of whether I run GFAP.py or GFAP-linux.py. I did not compile anything before I ran it, and I couldn't seem to find any installation instructions, so I assume I have not skipped any steps since cloning the code from gitghub?

Could you please advise what I can do to debug?

Best,

Katie

Issue about annotation with database failed

Thank you for developing such owesome tool for researchers in plant.

When I tried your tool on the website (http://43.139.112.84/go-kegg-pfam-index), I found that 2-annotation with database seems works not properly. I used the example data provided, but only swissprot database successed. Selecting other 3 databases will return message Opps!.

I also tried the standalone version on our own computer as python3 GFAP.py -o {outdir} -qn {cds.fasta} -qp {pep.fasta} -aws {species} -go -kegg -pfam -cpu {cpu} -awd nr -awd swissprot -mf -atf -agf. All databases mentioned in README are downloaded and put in the database dir. However, no nr and swissprot annotation is reported. (only GO_annotate, kegg_annotate, pfam_annotate, GF_result, and a blank swissprotf_result)

(By the way, the requirement svglab==1.4.1 is not fount in pip, and the program report that it cannot found svglib module. Is this a typo?)

Looking forward to your reply.

No instructions for setting up GFAP for use under Linux

Hi there,

I am attempting to run GFAP but based on the instructions in the manual, there does not seem to be any instructions on how to set anything up.

I managed to infer the directory structure expected by GFAP from the python error messages and now have something which looks like this, I am not sure whether this is correct:

ls go/goafter/*
go/goafter/Camellia_sinensis.txt.gz  go/goafter/go_database.txt.gz  go/goafter/pfam2go.txt.gz

After running the following command however, I get the following error message:

source/GFAP.py -aws Camellia_sinensis -go -qn test.fasta -o /lisc/user/emelianova/software/GFAP/test_out 
/bin/sh: line 1: ./bin/diamond: No such file or directory
Traceback (most recent call last):
  File "/lisc/user/emelianova/software/GFAP/source/GFAP.py", line 1311, in <module>
    align_annotation(file,inputtype,annotype,refspecies,evalue,algnment_type,algnment_percent,save,cpu,only_ID=None)
  File "/lisc/user/emelianova/software/GFAP/source/GFAP.py", line 135, in align_annotation
    annotprocess(goidfile,geneid2goid,blastfile,savefile,algnment_percent)
  File "/lisc/user/emelianova/software/GFAP/source/GFAP.py", line 84, in annotprocess
    with open(blastfile,encoding="utf-8") as f,open(savefile,"w") as f1:
         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory: '/lisc/user/emelianova/software/GFAP/GFAP-blastresult.txt'

Do you have any other documentation that perhaps I have missed on the github explaining how to set up GFAP correctly?

Best,

Katie

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.