1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
|
%global _empty_manifest_terminate_build 0
Name: python-GeneGrouper
Version: 1.0.3
Release: 1
Summary: Find and cluster genomic regions containing a seed gene
License: MIT License
URL: https://github.com/agmcfarland/GeneGrouper
Source0: https://mirrors.aliyun.com/pypi/web/packages/26/9b/a432e0124b851931e00c00871b667a06f318bc23c46edab6fb7eb24a6c64/GeneGrouper-1.0.3.tar.gz
BuildArch: noarch
%description
<img src="docs/overview_figure.png" alt="GeneGrouper overview figure" width=1000>
[Why use GeneGrouper?](https://github.com/agmcfarland/GeneGrouper/wiki#what-is-genegrouper)
[See GeneGrouper tutorial](https://github.com/agmcfarland/GeneGrouper/wiki/GeneGrouper-tutorial-with-data)
[See GeneGrouper tutorial](https://github.com/agmcfarland/GeneGrouper/wiki/GeneGrouper-tutorial-with-data)
[See GeneGrouper outputs](https://github.com/agmcfarland/GeneGrouper/wiki/Output-file-descriptions)
[See FAQs](https://github.com/agmcfarland/GeneGrouper/wiki/Frequently-Asked-Questions)
# Installation
GeneGrouper can be installed using pip
```pip install GeneGrouper```
[GeneGrouper has multiple dependences.]((https://github.com/agmcfarland/GeneGrouper/wiki/Installation-and-dependencies#requirements-and-dependencies))
Follow the code below to create a self-contained conda environment for GeneGrouper. **Recommended**
**Installing Python and bioinformatic dependencies for grouping**
```
conda create -n GeneGrouper_env python=3.9
source activate GeneGrouper_env #or try: conda activate GeneGrouper_env
conda config --add channels defaults
conda config --add channels bioconda
conda config --add channels conda-forge
pip install biopython scipy scikit-learn pandas matplotlib GeneGrouper
conda install -c bioconda mcl blast mmseqs2 fasttree mafft
```
**Installing R and required packages for visualizations**
```
conda install -c conda-forge r-base=4.1.1 r-svglite r-reshape r-ggplot2 r-cowplot r-dplyr r-gggenes r-ape r-phytools r-BiocManager r-codetools
# enter R environment
R
# install additional packages from CRAN
install.packages('groupdata2',repos='https://cloud.r-project.org/', quiet=TRUE)
# install additional packages from
BiocManager::install("ggtree")
# quit
q(save="no")
```
[For more information, see the installation wiki page](https://github.com/agmcfarland/GeneGrouper/wiki/Installation-and-dependencies)
# Inputs
### GeneGrouper has two required inputs:
1. A translated gene sequence in fasta format (with file extension .fasta/.txt)
2. A folder containing RefSeq GenBank-format genomes (with the file extension .gbff). [See instructions to download many RefSeq genomes at a time.](https://github.com/agmcfarland/GeneGrouper/wiki/Frequently-Asked-Questions#1-where-can-i-download-genbank-format-refseq-genomes-with-file-extension-gbff)
# Basic usage
#### Use `build_database` to make a GeneGrouper database of your RefSeq .gbff genomes
```
GeneGrouper -g /path/to/gbff -d /path/to/main_directory \
build_database
```
#### Use `find_regions` to search for regions containing a gene of interest and output to a search-specific directory
```
GeneGrouper -d /path/to/main_directory -n gene_search \
find_regions \
-f /path/to/query_gene.fasta
```
#### Use `visualize --visual_type main` to output visualizations of group gene architectures and their distribution within genomes and taxa
```
GeneGrouper -d /path/to/main_directory -n gene_search \
visualize \
--visual_type main
```
#### Use `visualize --visual_type group` to inspect a GeneGrouper group more closely. Replace <> with a group ID number.
```
GeneGrouper -d /path/to/main_directory -n gene_search \
visualize \
--visual_type group <>
```
#### Use `visualize --visual_type tree` to make a phylogenetic tree of each group's seed gene
```
GeneGrouper -d /path/to/main_directory -n gene_search \
visualize \
--visual_type tree
```
[See advanced usage examples](https://github.com/agmcfarland/GeneGrouper/wiki/Advanced-usage)
[See tutorial with provided example data](https://github.com/agmcfarland/GeneGrouper/wiki/GeneGrouper-tutorial-with-data)
# Outputs
1. **For each search ```find_regions``` outputs:**
* **Four** tabular files with quantitative and qualitative descriptions of grouping results.
* **One** fasta file containing all genes used in the analysis.
2. **For each search, ```visualize --visual_type main``` outputs:**
* **Three** main visualizations provided.
3. **For each search, ```visualize --visual_type group \--group_label <n>``` outputs:**
* **One** additional visualization per group, where ```--group_label <n>``` has `<n>` replaced with the group number.
* **Two** tabular files containing subgroup information for each ```--group_label <n>``` supplied.
4. **For each search, ```visualize --visual_type tree``` outputs:**
* **One** phylogenetic tree of each seed gene in each group.
[See complete output file descriptions](https://github.com/agmcfarland/GeneGrouper/wiki/Output-file-descriptions)
Each search and visualization will have the following file structure. Files under `visualizations` may differ.
```
├── main_directory
│ ├── search_results
│ │ ├── group_statistics_summmary.csv
│ │ ├── representative_group_member_summary.csv
│ │ ├── group_taxa_summary.csv
│ │ ├── group_regions.csv
│ │ ├── group_region_seqs.faa
│ │ ├── visualizations
│ │ │ ├── group_summary.png
│ │ │ ├── groups_by_taxa.png
│ │ │ ├── taxa_searched.png
│ │ │ ├── inspect_group_-1.png
│ │ │ ├── representative_seed_phylogeny.png
│ │ ├── internal_data
│ │ ├── subgroups
│ │ ├── seed_results.db
```
# Usage options
### Global flags
```
usage: GeneGrouper [-h] [-d] [-n] [-g] [-t]
{build_database,find_regions,visualize} ...
-h, --help show this help message and exit
-d , --project_directory
Main directory to contain the base files used for
region searching and clustering. Default=current
directory.
-n , --search_name Name of the directory to contain search-specific
results. Default=region_search
-g , --genomes_directory
Directory containing genbank-file format genomes with
the suffix .gbff. Default=./genomes.
-t , --threads Number of threads to use. Default=all threads.
```
### Subcommands
```
build_database Convert a set of genomes into a useable format for
GeneGrouper
find_regions Find regions given a translated gene and a set of
genomes
visualize Visualize GeneGrouper outputs. Three visualization options are provided.
Check the --visual_type help description.
```
### Subcommand flags
```build_database```
```
usage: GeneGrouper build_database [-h]
-h, --help show this help message and exit
```
```find_regions```
```
usage: GeneGrouper find_regions [-h] -f [-us] [-ds] [-i] [-c] [-hk] [--min_group_size] [-re] [--force]
-h, --help show this help message and exit
-f , --query_file Provide the absolute path to a fasta file containing a translated gene sequence.
-us , --upstream_search
Upstream search length in basepairs. Default=10000
-ds , --downstream_search
Downstream search length in basepairs. Default=10000
-i , --seed_identity
Identity cutoff for initial blast search. Default=60
-c , --seed_coverage
Coverage cutoff for initial blast search. Default=90
-hk , --seed_hits_kept
Number of blast hits to keep. Default=None
--min_group_size
The minimum number of gene regions to constitute a group. Default=ln(jaccard distance length)
-re , --recluster_iterations
Number of region re-clustering attempts after the initial clustering. Default=0
--force Flag to overwrite search name directory.
```
```visualize```
```
usage: GeneGrouper visualize [-h] [--visual_type] [--group_label]
--visual_type Choices: [main, group, tree]. Use main for main visualizations. Use group to
inspect specific group. Use tree for a phylogenetic tree of representative
seed sequencess. Default=main
--group_label The integer identifier of the group you wish to inspect. Default=-1
--image_format Choices: [png, svg]. Output image format. Use svg if you want to edit the
images. Default=png.
--tip_label_type Choices: [full, group]. Use full to include the sequence ID followed by group
ID. Use group to only have the group ID. Default=full
--tip_label_size Specify the tip label size in the output image. Default=2
```
# Citation
Alexander G McFarland, Nolan W Kennedy, Carolyn E Mills, Danielle Tullman-Ercek, Curtis Huttenhower, Erica M Hartmann, **Density-based binning of gene clusters to infer function or evolutionary history using GeneGrouper**, Bioinformatics, 2021;, btab752, https://doi.org/10.1093/bioinformatics/btab752
# Contact
Please message me at alexandermcfarland2022@u.northwestern.edu
Follow me on twitter [@alexmcfarland_](https://twitter.com/alexmcfarland_)!
%package -n python3-GeneGrouper
Summary: Find and cluster genomic regions containing a seed gene
Provides: python-GeneGrouper
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-GeneGrouper
<img src="docs/overview_figure.png" alt="GeneGrouper overview figure" width=1000>
[Why use GeneGrouper?](https://github.com/agmcfarland/GeneGrouper/wiki#what-is-genegrouper)
[See GeneGrouper tutorial](https://github.com/agmcfarland/GeneGrouper/wiki/GeneGrouper-tutorial-with-data)
[See GeneGrouper tutorial](https://github.com/agmcfarland/GeneGrouper/wiki/GeneGrouper-tutorial-with-data)
[See GeneGrouper outputs](https://github.com/agmcfarland/GeneGrouper/wiki/Output-file-descriptions)
[See FAQs](https://github.com/agmcfarland/GeneGrouper/wiki/Frequently-Asked-Questions)
# Installation
GeneGrouper can be installed using pip
```pip install GeneGrouper```
[GeneGrouper has multiple dependences.]((https://github.com/agmcfarland/GeneGrouper/wiki/Installation-and-dependencies#requirements-and-dependencies))
Follow the code below to create a self-contained conda environment for GeneGrouper. **Recommended**
**Installing Python and bioinformatic dependencies for grouping**
```
conda create -n GeneGrouper_env python=3.9
source activate GeneGrouper_env #or try: conda activate GeneGrouper_env
conda config --add channels defaults
conda config --add channels bioconda
conda config --add channels conda-forge
pip install biopython scipy scikit-learn pandas matplotlib GeneGrouper
conda install -c bioconda mcl blast mmseqs2 fasttree mafft
```
**Installing R and required packages for visualizations**
```
conda install -c conda-forge r-base=4.1.1 r-svglite r-reshape r-ggplot2 r-cowplot r-dplyr r-gggenes r-ape r-phytools r-BiocManager r-codetools
# enter R environment
R
# install additional packages from CRAN
install.packages('groupdata2',repos='https://cloud.r-project.org/', quiet=TRUE)
# install additional packages from
BiocManager::install("ggtree")
# quit
q(save="no")
```
[For more information, see the installation wiki page](https://github.com/agmcfarland/GeneGrouper/wiki/Installation-and-dependencies)
# Inputs
### GeneGrouper has two required inputs:
1. A translated gene sequence in fasta format (with file extension .fasta/.txt)
2. A folder containing RefSeq GenBank-format genomes (with the file extension .gbff). [See instructions to download many RefSeq genomes at a time.](https://github.com/agmcfarland/GeneGrouper/wiki/Frequently-Asked-Questions#1-where-can-i-download-genbank-format-refseq-genomes-with-file-extension-gbff)
# Basic usage
#### Use `build_database` to make a GeneGrouper database of your RefSeq .gbff genomes
```
GeneGrouper -g /path/to/gbff -d /path/to/main_directory \
build_database
```
#### Use `find_regions` to search for regions containing a gene of interest and output to a search-specific directory
```
GeneGrouper -d /path/to/main_directory -n gene_search \
find_regions \
-f /path/to/query_gene.fasta
```
#### Use `visualize --visual_type main` to output visualizations of group gene architectures and their distribution within genomes and taxa
```
GeneGrouper -d /path/to/main_directory -n gene_search \
visualize \
--visual_type main
```
#### Use `visualize --visual_type group` to inspect a GeneGrouper group more closely. Replace <> with a group ID number.
```
GeneGrouper -d /path/to/main_directory -n gene_search \
visualize \
--visual_type group <>
```
#### Use `visualize --visual_type tree` to make a phylogenetic tree of each group's seed gene
```
GeneGrouper -d /path/to/main_directory -n gene_search \
visualize \
--visual_type tree
```
[See advanced usage examples](https://github.com/agmcfarland/GeneGrouper/wiki/Advanced-usage)
[See tutorial with provided example data](https://github.com/agmcfarland/GeneGrouper/wiki/GeneGrouper-tutorial-with-data)
# Outputs
1. **For each search ```find_regions``` outputs:**
* **Four** tabular files with quantitative and qualitative descriptions of grouping results.
* **One** fasta file containing all genes used in the analysis.
2. **For each search, ```visualize --visual_type main``` outputs:**
* **Three** main visualizations provided.
3. **For each search, ```visualize --visual_type group \--group_label <n>``` outputs:**
* **One** additional visualization per group, where ```--group_label <n>``` has `<n>` replaced with the group number.
* **Two** tabular files containing subgroup information for each ```--group_label <n>``` supplied.
4. **For each search, ```visualize --visual_type tree``` outputs:**
* **One** phylogenetic tree of each seed gene in each group.
[See complete output file descriptions](https://github.com/agmcfarland/GeneGrouper/wiki/Output-file-descriptions)
Each search and visualization will have the following file structure. Files under `visualizations` may differ.
```
├── main_directory
│ ├── search_results
│ │ ├── group_statistics_summmary.csv
│ │ ├── representative_group_member_summary.csv
│ │ ├── group_taxa_summary.csv
│ │ ├── group_regions.csv
│ │ ├── group_region_seqs.faa
│ │ ├── visualizations
│ │ │ ├── group_summary.png
│ │ │ ├── groups_by_taxa.png
│ │ │ ├── taxa_searched.png
│ │ │ ├── inspect_group_-1.png
│ │ │ ├── representative_seed_phylogeny.png
│ │ ├── internal_data
│ │ ├── subgroups
│ │ ├── seed_results.db
```
# Usage options
### Global flags
```
usage: GeneGrouper [-h] [-d] [-n] [-g] [-t]
{build_database,find_regions,visualize} ...
-h, --help show this help message and exit
-d , --project_directory
Main directory to contain the base files used for
region searching and clustering. Default=current
directory.
-n , --search_name Name of the directory to contain search-specific
results. Default=region_search
-g , --genomes_directory
Directory containing genbank-file format genomes with
the suffix .gbff. Default=./genomes.
-t , --threads Number of threads to use. Default=all threads.
```
### Subcommands
```
build_database Convert a set of genomes into a useable format for
GeneGrouper
find_regions Find regions given a translated gene and a set of
genomes
visualize Visualize GeneGrouper outputs. Three visualization options are provided.
Check the --visual_type help description.
```
### Subcommand flags
```build_database```
```
usage: GeneGrouper build_database [-h]
-h, --help show this help message and exit
```
```find_regions```
```
usage: GeneGrouper find_regions [-h] -f [-us] [-ds] [-i] [-c] [-hk] [--min_group_size] [-re] [--force]
-h, --help show this help message and exit
-f , --query_file Provide the absolute path to a fasta file containing a translated gene sequence.
-us , --upstream_search
Upstream search length in basepairs. Default=10000
-ds , --downstream_search
Downstream search length in basepairs. Default=10000
-i , --seed_identity
Identity cutoff for initial blast search. Default=60
-c , --seed_coverage
Coverage cutoff for initial blast search. Default=90
-hk , --seed_hits_kept
Number of blast hits to keep. Default=None
--min_group_size
The minimum number of gene regions to constitute a group. Default=ln(jaccard distance length)
-re , --recluster_iterations
Number of region re-clustering attempts after the initial clustering. Default=0
--force Flag to overwrite search name directory.
```
```visualize```
```
usage: GeneGrouper visualize [-h] [--visual_type] [--group_label]
--visual_type Choices: [main, group, tree]. Use main for main visualizations. Use group to
inspect specific group. Use tree for a phylogenetic tree of representative
seed sequencess. Default=main
--group_label The integer identifier of the group you wish to inspect. Default=-1
--image_format Choices: [png, svg]. Output image format. Use svg if you want to edit the
images. Default=png.
--tip_label_type Choices: [full, group]. Use full to include the sequence ID followed by group
ID. Use group to only have the group ID. Default=full
--tip_label_size Specify the tip label size in the output image. Default=2
```
# Citation
Alexander G McFarland, Nolan W Kennedy, Carolyn E Mills, Danielle Tullman-Ercek, Curtis Huttenhower, Erica M Hartmann, **Density-based binning of gene clusters to infer function or evolutionary history using GeneGrouper**, Bioinformatics, 2021;, btab752, https://doi.org/10.1093/bioinformatics/btab752
# Contact
Please message me at alexandermcfarland2022@u.northwestern.edu
Follow me on twitter [@alexmcfarland_](https://twitter.com/alexmcfarland_)!
%package help
Summary: Development documents and examples for GeneGrouper
Provides: python3-GeneGrouper-doc
%description help
<img src="docs/overview_figure.png" alt="GeneGrouper overview figure" width=1000>
[Why use GeneGrouper?](https://github.com/agmcfarland/GeneGrouper/wiki#what-is-genegrouper)
[See GeneGrouper tutorial](https://github.com/agmcfarland/GeneGrouper/wiki/GeneGrouper-tutorial-with-data)
[See GeneGrouper tutorial](https://github.com/agmcfarland/GeneGrouper/wiki/GeneGrouper-tutorial-with-data)
[See GeneGrouper outputs](https://github.com/agmcfarland/GeneGrouper/wiki/Output-file-descriptions)
[See FAQs](https://github.com/agmcfarland/GeneGrouper/wiki/Frequently-Asked-Questions)
# Installation
GeneGrouper can be installed using pip
```pip install GeneGrouper```
[GeneGrouper has multiple dependences.]((https://github.com/agmcfarland/GeneGrouper/wiki/Installation-and-dependencies#requirements-and-dependencies))
Follow the code below to create a self-contained conda environment for GeneGrouper. **Recommended**
**Installing Python and bioinformatic dependencies for grouping**
```
conda create -n GeneGrouper_env python=3.9
source activate GeneGrouper_env #or try: conda activate GeneGrouper_env
conda config --add channels defaults
conda config --add channels bioconda
conda config --add channels conda-forge
pip install biopython scipy scikit-learn pandas matplotlib GeneGrouper
conda install -c bioconda mcl blast mmseqs2 fasttree mafft
```
**Installing R and required packages for visualizations**
```
conda install -c conda-forge r-base=4.1.1 r-svglite r-reshape r-ggplot2 r-cowplot r-dplyr r-gggenes r-ape r-phytools r-BiocManager r-codetools
# enter R environment
R
# install additional packages from CRAN
install.packages('groupdata2',repos='https://cloud.r-project.org/', quiet=TRUE)
# install additional packages from
BiocManager::install("ggtree")
# quit
q(save="no")
```
[For more information, see the installation wiki page](https://github.com/agmcfarland/GeneGrouper/wiki/Installation-and-dependencies)
# Inputs
### GeneGrouper has two required inputs:
1. A translated gene sequence in fasta format (with file extension .fasta/.txt)
2. A folder containing RefSeq GenBank-format genomes (with the file extension .gbff). [See instructions to download many RefSeq genomes at a time.](https://github.com/agmcfarland/GeneGrouper/wiki/Frequently-Asked-Questions#1-where-can-i-download-genbank-format-refseq-genomes-with-file-extension-gbff)
# Basic usage
#### Use `build_database` to make a GeneGrouper database of your RefSeq .gbff genomes
```
GeneGrouper -g /path/to/gbff -d /path/to/main_directory \
build_database
```
#### Use `find_regions` to search for regions containing a gene of interest and output to a search-specific directory
```
GeneGrouper -d /path/to/main_directory -n gene_search \
find_regions \
-f /path/to/query_gene.fasta
```
#### Use `visualize --visual_type main` to output visualizations of group gene architectures and their distribution within genomes and taxa
```
GeneGrouper -d /path/to/main_directory -n gene_search \
visualize \
--visual_type main
```
#### Use `visualize --visual_type group` to inspect a GeneGrouper group more closely. Replace <> with a group ID number.
```
GeneGrouper -d /path/to/main_directory -n gene_search \
visualize \
--visual_type group <>
```
#### Use `visualize --visual_type tree` to make a phylogenetic tree of each group's seed gene
```
GeneGrouper -d /path/to/main_directory -n gene_search \
visualize \
--visual_type tree
```
[See advanced usage examples](https://github.com/agmcfarland/GeneGrouper/wiki/Advanced-usage)
[See tutorial with provided example data](https://github.com/agmcfarland/GeneGrouper/wiki/GeneGrouper-tutorial-with-data)
# Outputs
1. **For each search ```find_regions``` outputs:**
* **Four** tabular files with quantitative and qualitative descriptions of grouping results.
* **One** fasta file containing all genes used in the analysis.
2. **For each search, ```visualize --visual_type main``` outputs:**
* **Three** main visualizations provided.
3. **For each search, ```visualize --visual_type group \--group_label <n>``` outputs:**
* **One** additional visualization per group, where ```--group_label <n>``` has `<n>` replaced with the group number.
* **Two** tabular files containing subgroup information for each ```--group_label <n>``` supplied.
4. **For each search, ```visualize --visual_type tree``` outputs:**
* **One** phylogenetic tree of each seed gene in each group.
[See complete output file descriptions](https://github.com/agmcfarland/GeneGrouper/wiki/Output-file-descriptions)
Each search and visualization will have the following file structure. Files under `visualizations` may differ.
```
├── main_directory
│ ├── search_results
│ │ ├── group_statistics_summmary.csv
│ │ ├── representative_group_member_summary.csv
│ │ ├── group_taxa_summary.csv
│ │ ├── group_regions.csv
│ │ ├── group_region_seqs.faa
│ │ ├── visualizations
│ │ │ ├── group_summary.png
│ │ │ ├── groups_by_taxa.png
│ │ │ ├── taxa_searched.png
│ │ │ ├── inspect_group_-1.png
│ │ │ ├── representative_seed_phylogeny.png
│ │ ├── internal_data
│ │ ├── subgroups
│ │ ├── seed_results.db
```
# Usage options
### Global flags
```
usage: GeneGrouper [-h] [-d] [-n] [-g] [-t]
{build_database,find_regions,visualize} ...
-h, --help show this help message and exit
-d , --project_directory
Main directory to contain the base files used for
region searching and clustering. Default=current
directory.
-n , --search_name Name of the directory to contain search-specific
results. Default=region_search
-g , --genomes_directory
Directory containing genbank-file format genomes with
the suffix .gbff. Default=./genomes.
-t , --threads Number of threads to use. Default=all threads.
```
### Subcommands
```
build_database Convert a set of genomes into a useable format for
GeneGrouper
find_regions Find regions given a translated gene and a set of
genomes
visualize Visualize GeneGrouper outputs. Three visualization options are provided.
Check the --visual_type help description.
```
### Subcommand flags
```build_database```
```
usage: GeneGrouper build_database [-h]
-h, --help show this help message and exit
```
```find_regions```
```
usage: GeneGrouper find_regions [-h] -f [-us] [-ds] [-i] [-c] [-hk] [--min_group_size] [-re] [--force]
-h, --help show this help message and exit
-f , --query_file Provide the absolute path to a fasta file containing a translated gene sequence.
-us , --upstream_search
Upstream search length in basepairs. Default=10000
-ds , --downstream_search
Downstream search length in basepairs. Default=10000
-i , --seed_identity
Identity cutoff for initial blast search. Default=60
-c , --seed_coverage
Coverage cutoff for initial blast search. Default=90
-hk , --seed_hits_kept
Number of blast hits to keep. Default=None
--min_group_size
The minimum number of gene regions to constitute a group. Default=ln(jaccard distance length)
-re , --recluster_iterations
Number of region re-clustering attempts after the initial clustering. Default=0
--force Flag to overwrite search name directory.
```
```visualize```
```
usage: GeneGrouper visualize [-h] [--visual_type] [--group_label]
--visual_type Choices: [main, group, tree]. Use main for main visualizations. Use group to
inspect specific group. Use tree for a phylogenetic tree of representative
seed sequencess. Default=main
--group_label The integer identifier of the group you wish to inspect. Default=-1
--image_format Choices: [png, svg]. Output image format. Use svg if you want to edit the
images. Default=png.
--tip_label_type Choices: [full, group]. Use full to include the sequence ID followed by group
ID. Use group to only have the group ID. Default=full
--tip_label_size Specify the tip label size in the output image. Default=2
```
# Citation
Alexander G McFarland, Nolan W Kennedy, Carolyn E Mills, Danielle Tullman-Ercek, Curtis Huttenhower, Erica M Hartmann, **Density-based binning of gene clusters to infer function or evolutionary history using GeneGrouper**, Bioinformatics, 2021;, btab752, https://doi.org/10.1093/bioinformatics/btab752
# Contact
Please message me at alexandermcfarland2022@u.northwestern.edu
Follow me on twitter [@alexmcfarland_](https://twitter.com/alexmcfarland_)!
%prep
%autosetup -n GeneGrouper-1.0.3
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-GeneGrouper -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 1.0.3-1
- Package Spec generated
|