Skip to content

Commit 6e6735c

Browse files
committed
cleanup and version update
update conda version update conda version update conda version
1 parent bafdaca commit 6e6735c

File tree

4 files changed

+45
-39
lines changed

4 files changed

+45
-39
lines changed

README.md

Lines changed: 41 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
[![ADRSM version](https://img.shields.io/badge/adrsm-v0.9.2-blue.svg)](https://github.com/maxibor/adrsm) [![Build Status](https://travis-ci.org/maxibor/adrsm.svg?branch=master)](https://travis-ci.org/maxibor/adrsm) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1462743.svg)](https://doi.org/10.5281/zenodo.1462743) [![Anaconda-Server Badge](https://anaconda.org/maxibor/adrsm/badges/installer/conda.svg)](https://anaconda.org/maxibor/adrsm)
22

3-
4-
5-
6-
73
* * *
84

95
<img src="./img/logo_adrsm.png" width="300">
@@ -38,43 +34,53 @@ You can cite ADRSM like this:
3834
# Help
3935

4036
$ adrsm --help
41-
usage: ADRSM v0.9.3 [-h] [-r READLENGTH] [-n NBINOM] [-fwd FWDADAPT]
42-
[-rev REVADAPT] [-p GEOM_P] [-m MIN] [-M MAX] [-o OUTPUT]
43-
[-s STATS] [-se SEED] [-t THREADS]
44-
confFile
37+
Usage: adrsm [OPTIONS] CONFFILE
38+
39+
==================================================
40+
ADRSM: Ancient DNA Read Simulator for Metagenomics
41+
Author: Maxime Borry
42+
Contact: <borry[at]shh.mpg.de>
43+
Homepage & Documentation: github.com/maxibor/adrsm
44+
45+
CONFFILE: path to ADRSM configuration file
46+
47+
Options:
48+
--version Show the version and exit.
49+
-r, --readLength INTEGER Average read length [default: 76]
50+
-n, --nbinom INTEGER n parameter for Negative Binomial insert length
51+
distribution [default: 8]
52+
53+
-fwd, --fwdAdapt TEXT Forward adaptor sequence [default: AGATCGGAAGA
54+
GCACACGTCTGAACTCCAGTCACNNNNNNATCTCGTATGCCGTCTTC
55+
TGCTTG]
56+
57+
-rev, --revAdapt TEXT Reverse adaptor sequence [default: AGATCGGAAGA
58+
GCGTCGTGTAGGGAAAGAGTGTAGATCTCGGTGGTCGCCGTATCATT
59+
]
4560

46-
==================================================
61+
-p, --geom_p FLOAT RANGE Geometric distribution parameter for
62+
deamination [default: 0.5]
4763

48-
ADRSM: Ancient DNA Read Simulator for Metagenomics
64+
-m, --minD FLOAT RANGE Deamination substitution base frequency
65+
[default: 0.01]
4966

50-
Author: Maxime Borry
67+
-M, --maxD FLOAT RANGE Deamination substitution max frequency
68+
[default: 0.3]
5169

52-
Contact: <borry[at]shh.mpg.de>
70+
-e, --effort INTEGER Sequencing effort, maximum number of reads to
71+
be generated [default: 100]
5372

54-
Homepage & Documentation: github.com/maxibor/adrsm
55-
==================================================
73+
-s, --seed INTEGER Seed for random generator generator [default:
74+
42]
5675

76+
-t, --threads INTEGER RANGE Number of threads for parallel processing
77+
[default: 2]
5778

58-
positional arguments:
59-
confFile path to configuration file
79+
-o, --output PATH Fastq output file basename [default:
80+
./metagenome]
6081

61-
optional arguments:
62-
-h, --help show this help message and exit
63-
-r READLENGTH Average read length. Default = 76
64-
-n NBINOM n parameter for Negative Binomial insert length distribution.
65-
Default = 8
66-
-fwd FWDADAPT Forward adaptor. Default = AGATCGGAAGAGCACACGTCTGAACTCCAGTCAC
67-
NNNNNNATCTCGTATGCCGTCTTCTGCTTG
68-
-rev REVADAPT Reverse adaptor. Default =
69-
AGATCGGAAGAGCGTCGTGTAGGGAAAGAGTGTAGATCTCGGTGGTCGCCGTATCATT
70-
-p GEOM_P Geometric distribution parameter for deamination. Default =
71-
0.5
72-
-m MIN Deamination substitution base frequency. Default = 0.001
73-
-M MAX Deamination substitution max frequency. Default = 0.3
74-
-o OUTPUT Output file basename. Default = ./metagenome.*
75-
-s STATS Statistic file. Default = stats.csv
76-
-se SEED Seed for random generator. Default = 7357
77-
-t THREADS Number of threads for parallel processing. Default = 2
82+
-s, --stats PATH Summary statistics file [default: ./stats.csv]
83+
--help Show this message and exit.
7884

7985
## Configuration file (`confFile`)
8086

@@ -89,8 +95,8 @@ The configuration `.csv` file describes, one line per genome, the different simu
8995

9096
**Example:** [**short_genome_list.csv**](test/data/short_genome_list.csv)
9197

92-
| genome(mandatory) | insert_size(mandatory) | coverage(mandatory) | deamination(mandatory) | mutation_rate(optional) | age(optional) |
93-
| ---------------------------- | ---------------------- | ------------------- | ---------------------- | ----------------------- | ------------- |
98+
| genome(mandatory) | insert_size(mandatory) | coverage(mandatory) | deamination(mandatory) | mutation_rate(optional) | age(optional) |
99+
| ------------------------------------------- | ---------------------- | ------------------- | ---------------------- | ----------------------- | ------------- |
94100
| ./data/genomes/Agrobacterium_tumefaciens.fa | 47 | 0.1 | yes | 10e-8 | 10000 |
95101
| ./data/genomes/Bacillus_anthracis.fa | 48 | 0.2 | no | | |
96102

adrsm/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "0.9.4"
1+
__version__ = "0.9.5"

adrsm/adrsm.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,6 @@ def read_config(infile):
136136
genomes[row_name] = row
137137

138138
for genome in genomes:
139-
print(genome)
140-
print(genomes[genome])
141139
genomes[genome] = {k.replace(" ", ""): v for k, v in genomes[genome].items()}
142140
genomes[genome]["size"] = int(genomes[genome].pop("insert_size(mandatory)"))
143141
genomes[genome]["cov"] = float(genomes[genome].pop("coverage(mandatory)"))
@@ -178,6 +176,7 @@ def main(
178176
stat_dict = {}
179177
all_genomes = read_config(conffile)
180178
all_reads = []
179+
print("-- ADRSM v" + __version__ + " --")
181180
for agenome in all_genomes.keys():
182181
reads, stat_and_run = ad.run_read_simulation_multi(
183182
INFILE=agenome,

conda/meta.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{% set version = "v0.9.4" %}
1+
{% set version = "0.9.5" %}
22

33
package:
44
name: adrsm
@@ -18,6 +18,7 @@ requirements:
1818
- scipy >=1.3.1
1919
- requests >=2.22
2020
- click
21+
- xopen
2122

2223

2324
test:

0 commit comments

Comments
 (0)