Skip to content
A Cross-platform and Efficient NCBI Taxonomy Toolkit
Branch: master
Clone or download
Latest commit 94f4304 Jul 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github v0.1.8 Apr 26, 2017
bench update benchmark result Jul 7, 2019
doc update doc Jul 10, 2019
taxonkit v0.5.0 Jul 7, 2019
.gitignore taxonkit taxid-changelog: fix bug and reduce memory usage Jul 4, 2019
HISTORY.md v0.5.0 Jul 7, 2019
LICENSE taxonkit lineage: check merged and deleted taxids. fix #19 and #10 Jul 7, 2019
README.md update doc Jul 10, 2019

README.md

TaxonKit - A Cross-platform and Efficient NCBI Taxonomy Toolkit

Subcommands

  • list list taxon tree of given taxids
  • lineage query lineage of given taxids (supporting STDIN), performance benchmark (details):
  • reformat reformat lineage (supporting STDIN)
  • name2taxid query taxid by taxon scientific name (supporting STDIN)
  • taxid-changelog create taxid changelog from dump archives

Misc

  • version print version information and check for update
  • genautocomplete generate shell autocompletion script

Installation

Go to Download Page for more download options and changelogs.

TaxonKit is implemented in Go programming language, executable binary files for most popular operating systems are freely available in release page.

Method 1: Download binaries (latest stable/dev version)

Just download compressed executable file of your operating system, and decompress it with tar -zxvf *.tar.gz command or other tools. And then:

  1. For Linux-like systems

    1. If you have root privilege simply copy it to /usr/local/bin:

       sudo cp taxonkit /usr/local/bin/
      
    2. Or copy to anywhere in the environment variable PATH:

       mkdir -p $HOME/bin/; cp taxonkit $HOME/bin/
      
  2. For windows, just copy taxonkit.exe to C:\WINDOWS\system32.

Method 2: Install via conda (latest stable version) Install-with-conda Anaconda Cloud downloads

conda install -c bioconda taxonkit

Method 3: Install via homebrew (latest stable version)

brew install brewsci/bio/taxonkit

Method 4: For Go developer (latest stable/dev version)

go get -u github.com/shenwei356/taxonkit/taxonkit

Bash-completion

Note: The current version supports Bash only. This should work for *nix systems with Bash installed.

Howto:

  1. run: taxonkit genautocomplete

  2. create and edit ~/.bash_completion file if you don't have it.

     nano ~/.bash_completion
    

    add the following:

     for bcfile in ~/.bash_completion.d/* ; do
       . $bcfile
     done
    

Citation

If you use TaxonKit in your work, please cite the preprint.

Contact

Email me for any problem when using taxonkit. shenwei356(at)gmail.com

Create an issue to report bugs, propose new functions or ask for help.

License

MIT License

You can’t perform that action at this time.