Skip to content
This repository has been archived by the owner on Mar 22, 2021. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wdesouza committed Feb 13, 2020
1 parent 467f3f3 commit dacce16
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 34 deletions.
35 changes: 2 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
# MethSeq - Automation tool for high-throughput sequencing DNA methylation data

Install **MethSeq** command-line tool

```bash
pip3 install --force --user git+https://github.com/labbcb/methseq.git
```

Supported sequencing protocols for identification of DNA methylation

- WGBS
- Pico-Methyl
- EMSeq

> Reduced-representation bisulfite sequencing (RRBS) data is not supported!
> Reduced-representation bisulfite sequencing (RRBS) is not supported!
Required software

Expand Down Expand Up @@ -118,36 +112,11 @@ methseq wgbs \
```

To process a single sample (EMSeq) passing path to specific file.
It is useful to run **methseq** on files that are in the same directory with other files.
It is useful to run **MethSeq** on files that are not in the same directory.

```bash
methseq emseq \
--fastq_1 /path/to/emseq_1.fastq.gz \
--fastq_2 /path/to/emseq_2.fastq.gz \
/path/to/wgbs_result
```

## Development

Clone git repository from GitHub.

```bash
git clone https://github.com/labbcb/methseq.git
cd methseq
```

Create virtual environment and install development version.

```bash
python3 -m venv venv
source venv/bin/activate
pip install --requirement requirements.txt
```

Publish new methseq version to Pypi.

```bash
pip install setuptools wheel twine
python setup.py sdist bdist_wheel
twine upload -u $PYPI_USER -p $PYPI_PASS dist/*
```
7 changes: 6 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,20 @@

from setuptools import find_packages

with open("README.md", "r") as fh:
long_description = fh.read()

setup(
name='methseq',
version='1.0.0',
version='1.0.1',
packages=find_packages(),
url='https://github.com/labbcb/methseq',
license='GPLv3',
author='Welliton de Souza, Danielle Brunno, Jaqueline Geraldis',
author_email='well309@gmail.com',
description='Automation tool for high-throughput sequencing DNA methylation data',
long_description=long_description,
long_description_content_type="text/markdown",
requires=['click', 'requests'],
include_package_data=True,
entry_points='''
Expand Down

0 comments on commit dacce16

Please sign in to comment.