Skip to content

Commit 1ddc6fc

Browse files
committed
Merged dev into recipes
2 parents 94c4dc1 + ab3d5fa commit 1ddc6fc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+1180
-82
lines changed

changelog.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,52 @@
11
# Changelog
22

3+
## Changes in upcoming release (`dev` branch)
4+
5+
### Components changes
6+
7+
- Added new `disableRR` param in the `spades` component that disables repeat
8+
resolution
9+
10+
### New components
11+
12+
- Added component `abyss`.
13+
14+
### Minor/Other changes
15+
16+
- Added removal of duplicate IDs from `reads_download` component input.
17+
- Added seed parameter to `downsample_fastq` component.
18+
- Added default docker option to avoid docker permission errors.
19+
- Changed the default URL generated by inspect and report commands.
20+
21+
### Bug fixes
22+
23+
- Fixed forks with same source process name.
24+
- Fixed `inspect` issue when tasks took more than a day in duration.
25+
26+
## 1.3.1
27+
28+
### Features
29+
30+
- Added a new `clearInput` parameter to components that change their input.
31+
The aim of this option is to allow the controlled removal of temporary files,
32+
which is particularly useful in very large workflows.
33+
34+
### Components changes
35+
36+
- Updated images for components `mash_dist`, `mash_screen` and
37+
`mapping_patlas`.
38+
39+
### New components
40+
41+
- Added component `fast_ani`.
42+
43+
### Minor/Other changes
44+
45+
- Added `--export-directives` option to `build` mode to export component's
46+
directives in JSON format to standard output.
47+
- Added more date information in `inspect` mode, including the year and the
48+
locale of the executing system.
49+
350
## 1.3.0
451

552
### Features

docker/Dockerfile

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
FROM python:3.6-alpine3.7
2+
MAINTAINER Bruno Gonçalves <bfgoncalves@medicina.ulisboa.pt>
3+
4+
RUN apk add --no-cache git
5+
6+
WORKDIR /flowcraft
7+
8+
# Clone FlowCraft
9+
RUN git clone https://github.com/assemblerflow/flowcraft.git
10+
WORKDIR ./flowcraft
11+
12+
# Install flowcraft
13+
RUN python setup.py install
14+
15+
WORKDIR /flowcraft
16+
17+
# Remove unnecessary packages
18+
RUN apk del git

docs/user/available_components.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,13 @@ Distance Estimation
9999
plasmid database and generates a JSON input file for pATLAS. This component
100100
searches for containment of a given sequence in read sequencing data.
101101
However if a different database is provided it can use mash screen for other
102-
purporses.
102+
purposes.
103+
104+
- :doc:`components/fast_ani`: Performs pairwise comparisons between fastas,
105+
given a multifasta as input for fastANI. It will split the multifasta into
106+
single fastas that will then be provided as a matrix. The output will be the
107+
all pairwise comparisons that pass the minimum of 50 aligned sequences with a
108+
default length of 200 bp.
103109

104110
- :doc:`components/mash_sketch_fasta`: Performs mash sketch for fasta files.
105111

docs/user/basic_usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@ Local visualization
393393
:::::::::::::::::::
394394

395395
The FlowCraft report JSON file can also be visualized locally by drag and dropping
396-
it into the FlowCraft web application page, currently hosted at http://192.92.149.169/reports
396+
it into the FlowCraft web application page, currently hosted at http://www.flowcraft.live/reports
397397

398398
Offline visualization
399399
:::::::::::::::::::::

docs/user/components/downsample_fastq.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Parameters
2323
- ``genomeSize``: Genome size estimate for the samples. It is used to
2424
estimate the coverage.
2525
- ``depth``: The target depth to which the reads should be subsampled.
26+
- ``seed``: The seed number for seqtk. By default it is 100.
2627

2728
Published results
2829
-----------------

docs/user/components/fast_ani.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
fast_ani
2+
========
3+
4+
Purpose
5+
-------
6+
7+
This component performs pairwise comparisons between fastas,
8+
given a multifasta as input for fastANI. It will split the multifasta into
9+
single fastas that will then be provided as a matrix. The output will be the
10+
all pairwise comparisons that pass the minimum of 50 aligned sequences with a
11+
default length of 200 bp.
12+
13+
Input/Output type
14+
------------------
15+
16+
- Input type: ``fasta``
17+
- Output type: ``None``
18+
19+
20+
Parameters
21+
----------
22+
23+
- ``fragLen``: Sets the minimum size of the fragment to be passed to
24+
`--fragLen` argument of fastANI.
25+
26+
27+
Published results
28+
-----------------
29+
30+
- ``results/fast_ani/``: A text file with the extension `.out`, which has all
31+
the pairwise comparisons between sequences, reporting ANI.
32+
33+
34+
Published reports
35+
-----------------
36+
37+
None.
38+
39+
40+
Default directives
41+
------------------
42+
43+
- ``fastAniMatrix``:
44+
- ``container``: flowcraft/fast_ani
45+
- ``version``: 1.1.0-2
46+
- ``cpus``: 20
47+
- ``memory``: { 30.GB * task.attempt }

docs/user/components/mapping_patlas.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ Default directives
6060

6161
- ``mappingBowtie``:
6262
- ``container``: flowcraft/mapping-patlas
63-
- ``version``: 1.4.1
63+
- ``version``: 1.6.0-1
6464
- ``samtoolsView``:
6565
- ``container``: flowcraft/mapping-patlas
66-
- ``version``: 1.4.1
66+
- ``version``: 1.6.0-1
6767
- ``jsonDumpingMapping``:
6868
- ``container``: flowcraft/mapping-patlas
69-
- ``version``: 1.4.1
69+
- ``version``: 1.6.0-1

docs/user/components/mash_dist.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Default directives
6565

6666
- ``runMashDist``:
6767
- ``container``: flowcraft/mash-patlas
68-
- ``version``: 1.4.1
68+
- ``version``: 1.6.0-1
6969
- ``mashDistOutputJson``:
7070
- ``container``: flowcraft/mash-patlas
71-
- ``version``: 1.4.1
71+
- ``version``: 1.6.0-1

docs/user/components/mash_screen.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Default directives
6060

6161
- ``mashScreen``:
6262
- ``container``: flowcraft/mash-patlas
63-
- ``version``: 1.4.1
63+
- ``version``: 1.6.0-1
6464
- ``mashOutputJson``:
6565
- ``container``: flowcraft/mash-patlas
66-
- ``version``: 1.4.1
66+
- ``version``: 1.6.0-1

flowcraft/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

2-
__version__ = "1.3.0"
3-
__build__ = "21092018"
2+
__version__ = "1.3.1"
3+
__build__ = "27092018"
44
__author__ = "Diogo N. Silva, Tiago F. Jesus, Ines Mendes, Bruno Ribeiro-Goncalves"
55
__copyright__ = "Diogo N. Silva"
66
__license__ = "GPL3"

0 commit comments

Comments
 (0)