| 1 | package App::Egaz; | ||
| 2 | |||
| 3 | 20 | our $VERSION = "0.2.9"; | |
| 4 | |||
| 5 | 20 | ▶ | use strict; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 6 | 20 | ▶ | use warnings; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 7 | 20 | ▶ | use App::Cmd::Setup -app; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 8 | |||
| 9 | =pod | ||
| 10 | |||
| 11 | =encoding utf-8 | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | App::Egaz - B<E>asy B<G>enome B<A>ligner | ||
| 16 | |||
| 17 | =head1 SYNOPSIS | ||
| 18 | |||
| 19 | egaz <command> [-?h] [long options...] | ||
| 20 | --help (or -h) show help | ||
| 21 | aka -? | ||
| 22 | |||
| 23 | Available commands: | ||
| 24 | |||
| 25 | commands: list the application's commands | ||
| 26 | help: display a command's help screen | ||
| 27 | |||
| 28 | blastlink: link sequences by blastn | ||
| 29 | blastmatch: matched positions by blastn in genome sequences | ||
| 30 | blastn: blastn wrapper between two fasta files | ||
| 31 | exactmatch: exact matched positions in genome sequences | ||
| 32 | fas2vcf: list variations in blocked fasta file | ||
| 33 | formats: formats of files use in this project | ||
| 34 | lastz: lastz wrapper for two genomes or self alignments | ||
| 35 | lav2axt: convert .lav files to .axt | ||
| 36 | lav2psl: convert .lav files to .psl | ||
| 37 | lpcnam: the pipeline of pairwise lav-psl-chain-net-axt-maf | ||
| 38 | maskfasta: soft/hard-masking sequences in a fasta file | ||
| 39 | multiz: multiz step by step | ||
| 40 | normalize: normalize lav files | ||
| 41 | partition: partitions fasta files by size | ||
| 42 | prepseq: preparing steps for lastz | ||
| 43 | raxml: raxml wrapper to construct phylogenetic trees | ||
| 44 | repeatmasker: RepeatMasker wrapper | ||
| 45 | template: create executing bash files | ||
| 46 | |||
| 47 | Run C<egaz help command-name> for usage information. | ||
| 48 | |||
| 49 | =head1 DESCRIPTION | ||
| 50 | |||
| 51 | App::Egaz stands for B<E>asy B<G>enome B<A>ligner. | ||
| 52 | |||
| 53 | B<Caution>: C<egaz lpcnam> implements UCSC's chain-net pipeline, but some parts, | ||
| 54 | e.g. C<axtChain>, don't work correctly under macOS. Use C<egaz lastz>'s build in | ||
| 55 | chaining mechanism (C<C=2>) instead. | ||
| 56 | |||
| 57 | =head1 INSTALLATION | ||
| 58 | |||
| 59 | cpanm --installdeps https://github.com/wang-q/App-Egaz/archive/0.2.8.tar.gz | ||
| 60 | curl -fsSL https://raw.githubusercontent.com/wang-q/App-Egaz/master/share/check_dep.sh | bash | ||
| 61 | cpanm -nq https://github.com/wang-q/App-Egaz/archive/0.2.8.tar.gz | ||
| 62 | # cpanm -nq https://github.com/wang-q/App-Egaz.git | ||
| 63 | |||
| 64 | =head1 CONTAINER | ||
| 65 | |||
| 66 | C<egaz> has tons of dependencies, so the simplest way to use it is using a container system. | ||
| 67 | C<Singularity> 3.x is the preferred one. | ||
| 68 | |||
| 69 | # Pull and build the image | ||
| 70 | singularity pull docker://wangq/egaz:master | ||
| 71 | |||
| 72 | # Run a single command | ||
| 73 | singularity run egaz_master.sif egaz help | ||
| 74 | |||
| 75 | # Interactive shell | ||
| 76 | # Note: | ||
| 77 | # * .sif is immutable | ||
| 78 | # * $HOME, /tmp, and $PWD are automatically loaded | ||
| 79 | # * All actions affect the host paths | ||
| 80 | # * Singularity Desktop for macOS isn't Fully functional. | ||
| 81 | # * https://github.com/hpcng/singularity/issues/5215 | ||
| 82 | singularity shell egaz_master.sif | ||
| 83 | |||
| 84 | # With Docker | ||
| 85 | docker run -it --rm -v "$(pwd)"/egaz:/egaz wangq/egaz:master | ||
| 86 | |||
| 87 | =head1 EXAMPLE | ||
| 88 | |||
| 89 | =over 4 | ||
| 90 | |||
| 91 | =item Multiple genome alignments of I<Saccharomyces cerevisiae> strains and other I<Saccharomyces> species | ||
| 92 | |||
| 93 | =over 8 | ||
| 94 | |||
| 95 | =item Detailed steps L<https://github.com/wang-q/App-Egaz/blob/master/doc/Scer.md#detailed-steps> | ||
| 96 | |||
| 97 | =item C<egaz template> steps L<https://github.com/wang-q/App-Egaz/blob/master/doc/Scer.md#template-steps> | ||
| 98 | |||
| 99 | =back | ||
| 100 | |||
| 101 | =item Self alignments of I<S. cerevisiae> reference strain S288c | ||
| 102 | |||
| 103 | =over 8 | ||
| 104 | |||
| 105 | =item Detailed steps L<https://github.com/wang-q/App-Egaz/blob/master/doc/Scer-self.md#detailed-steps> | ||
| 106 | |||
| 107 | =item C<egaz template> steps L<https://github.com/wang-q/App-Egaz/blob/master/doc/Scer-self.md#template-steps> | ||
| 108 | |||
| 109 | =back | ||
| 110 | |||
| 111 | =back | ||
| 112 | |||
| 113 | =head1 AUTHOR | ||
| 114 | |||
| 115 | Qiang Wang E<lt>wang-q@outlook.comE<gt> | ||
| 116 | |||
| 117 | =head1 LICENSE | ||
| 118 | |||
| 119 | This software is copyright (c) 2018 by Qiang Wang. | ||
| 120 | |||
| 121 | This library is free software; you can redistribute it and/or modify | ||
| 122 | it under the same terms as Perl itself. | ||
| 123 | |||
| 124 | =head1 CITATION | ||
| 125 | |||
| 126 | Yan Wang*, Xiaohui Liang*, Yuqian Jiang, Danjiang Dong, Cong Zhang, Tianqiang Song, Ming Chen, Yong You, Han Liu, Min Ge, Haibin Dai, Fengchan Xi, Wanqing Zhou, Jian-Qun Chen, Qiang Wang#, Qihan Chen#, Wenkui Yu#. | ||
| 127 | |||
| 128 | Novel fast pathogen diagnosis method for severe pneumonia patients in the intensive care unit: randomized clinical trial. | ||
| 129 | |||
| 130 | eLife. 2022; 11: e79014. | ||
| 131 | |||
| 132 | DOI: L<https://doi.org/10.7554/eLife.79014> | ||
| 133 | |||
| 134 | '*': These authors contributed equally to this work | ||
| 135 | '#': For correspondence | ||
| 136 | |||
| 137 | =cut | ||
| 138 | |||
| 139 | 20 | 1; | |
| 140 | |||
| 141 | __END__ | ||