Skip to content

Commit

Permalink
minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
PengNi committed Feb 26, 2022
1 parent cfacf9f commit c8d5177
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ deepsignal-plant applies BiLSTM to detect methylation from Nanopore reads. It is
#### Known issues
- The VBZ compression issue is not completely solved yet. Please try the commands listed below, normally it will work after setting `HDF5_PLUGIN_PATH`:
```shell
# 1. install hdf5/hdf5-tools
# 1. install hdf5/hdf5-tools (maybe not necessary)
# ubuntu
sudo apt-get install libhdf5-serial-dev hdf5-tools
# centos
Expand All @@ -41,15 +41,15 @@ References: [issue #8](https://github.com/PengNi/deepsignal-plant/issues/8), [to

## Installation
deepsignal-plant is built on [Python3](https://www.python.org/) and [PyTorch](https://pytorch.org/). [Guppy](https://nanoporetech.com/community) and [tombo](https://github.com/nanoporetech/tombo) are required to basecall and re-squiggle the raw signals from nanopore reads before running deepsignal-plant.
- Prerequisites:\
- Prerequisites: \
[Python3.*](https://www.python.org/) (version>=3.6)\
[Guppy](https://nanoporetech.com/community) (version>=3.6.1)\
[tombo](https://github.com/nanoporetech/tombo) (version 1.5.1)
- Dependencies:\
[numpy](http:https://www.numpy.org/)\
[h5py](https://github.com/h5py/h5py)\
[statsmodels](https://github.com/statsmodels/statsmodels/)\
[scikit-learn](https://scikit-learn.org/stable/)\
- Dependencies: \
[numpy](http:https://www.numpy.org/) \
[h5py](https://github.com/h5py/h5py) \
[statsmodels](https://github.com/statsmodels/statsmodels/) \
[scikit-learn](https://scikit-learn.org/stable/) \
[PyTorch](https://pytorch.org/) (version >=1.2.0, <=1.7.0?)

#### 1. Create an environment
Expand Down Expand Up @@ -153,7 +153,7 @@ python /path/to/deepsignal_plant/scripts/split_freq_file_by_5mC_motif.py \
Before running deepsignal, the raw reads should be basecalled by [Guppy (version>=3.6.1)](https://nanoporetech.com/community) and then be processed by the *re-squiggle* module of [tombo (version 1.5.1)](https://github.com/nanoporetech/tombo).

Note:
- If the fast5 files are in multi-read FAST5 format, please use _multi_to_single_fast5_ command from the [ont_fast5_api package](https://github.com/nanoporetech/ont_fast5_api) to convert the fast5 files before using Guppy/tombo (Ref to [issue #173](https://github.com/nanoporetech/tombo/issues/173) in [tombo](https://github.com/nanoporetech/tombo)).
- If the fast5 files are in multi-read FAST5 format, please use _multi_to_single_fast5_ command from the [ont_fast5_api package](https://github.com/nanoporetech/ont_fast5_api) to convert the fast5 files before using [Guppy](https://nanoporetech.com/community) and [tombo](https://nanoporetech.com/community) (Ref to [issue #173](https://github.com/nanoporetech/tombo/issues/173) in [tombo](https://github.com/nanoporetech/tombo)).
```bash
multi_to_single_fast5 -i $multi_read_fast5_dir -s $single_read_fast5_dir -t 30 --recursive
```
Expand Down
2 changes: 1 addition & 1 deletion deepsignal_plant/deepsignal_plant.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ def main():
parser = argparse.ArgumentParser(prog='deepsignal_plant',
description="detecting base modifications from Nanopore sequencing reads of "
"plants, "
"deepsignal_plant contains four modules:\n"
"deepsignal_plant contains five modules:\n"
"\t%(prog)s call_mods: call modifications\n"
"\t%(prog)s call_freq: call frequency of modifications "
"at genome level\n"
Expand Down

0 comments on commit c8d5177

Please sign in to comment.