Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ddesvillechabrol committed Jan 9, 2023
1 parent 3239479 commit b56da33
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,26 @@ For developers:

git clone git@github.com:sequana/MergeGI.git
cd MergeGI
pip install -e .[testing]
poetry install
poetry shell

We also provide a pipeline for demultiplexing MGI data in Snakemake, which can be installed as an extra package:

pip install mergegi[sequana]

It installs **snakemake** and **sequana_pipetools** and you have access to **sequana_mergegi** command.

For developers:

git clone git@github.com:sequana/MergeGI.git
cd MergeGI
poetry install --all-extras
poetry shell

## Apptainers

MergeGI is available as an apptainer image within the https://damona.readthedocs.io project. For example, the version 0.1.0 is available here: https://sandbox.zenodo.org/record/1134857/files/mergegi_0.0.1.img (60Mb).


## Overview

The main goal of **MergeGI** is to select and merge the FastQ files generated by a MGI sequencer into a list of FastQ files directly usable for subsequent bioinformatics analysis. Why do we need to do this preprocessing ?
Expand All @@ -48,7 +61,6 @@ Those 3 steps should be managed seemlessly by our tool given a sample sheet and

## General Usage and Examples


The data structure expected by **MergeGI** is the expected output directoy of MGI runs:

OutputFq/Flowcell/L01
Expand Down Expand Up @@ -102,6 +114,7 @@ mergegi --samplesheet samplesheet.csv --input-directory mgi_raw_data --output-di

| Version | Description |
|----------|---
| 0.2.0 | use poetry and add sequana_mergegi as extra dependencies |
| 0.1.0 | simplify CI and use pyproject |
| 0.0.0 | firs release |

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"

[tool.poetry]
name = "MergeGI"
version= "0.4.0"
version= "0.2.0"
authors=["Sequana Team"]
description="Merge MGI fastq files"
license = "BSD-4-Clause"
Expand Down

0 comments on commit b56da33

Please sign in to comment.