Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yangfangs committed Nov 21, 2018
1 parent e012711 commit c00de11
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 5 deletions.
9 changes: 7 additions & 2 deletions docs/docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
### 1. What is the input of PhySpeTree?

Users only need to prepare a TXT file containing [KEGG](http://www.genome.jp/kegg/catalog/org_list.html) abbreviated species names. For example, [organism_example_list](https://gitlab.com/xiaoxiaoyang/physpetools/raw/master/examples/organism_example_list.txt).
* Users only need to prepare a TXT file containing [KEGG](http://www.genome.jp/kegg/catalog/org_list.html) abbreviated species names.
For example, [organism_example_list](https://gitlab.com/xiaoxiaoyang/physpetools/raw/master/examples/organism_example_list.txt).

* Now, PhySpeTree not only supported the user input three- or four-letter organism codes (KEGG database organism codes)
but also the NCBI taxonomy id (for example human taxonomy id is 9606).
You can search taxonomy id form [NCBI taxonomy database](https://www.ncbi.nlm.nih.gov/taxonomy).

### 2. How to explain PhySpeTree outputs?

Expand Down Expand Up @@ -62,5 +67,5 @@ Ribosomal protein S13 | K02953 | K02

### 4. How are SSU rRAN created?

The SSU rRAN sequences are created from the [SILVA](<https://www.arb-silva.de/>) database (123.1 release). Sequences haven been truncated, which means unaligned nucleotides are removed.
The SSU rRAN sequences are created from the [SILVA](<https://www.arb-silva.de/>) database (Release 132, Released: 13.12.2017). Sequences haven been truncated, which means unaligned nucleotides are removed.

2 changes: 1 addition & 1 deletion docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# PhySpeTree: automatically reconstructing phylogenetic species tree

**PhySpeTree is implemented in Python language, designed for Linux systems.**
**PhySpeTree is implemented in Python language (supports Python2.7+ and Python3+), designed for Linux systems.**

## Introduction

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -727,15 +727,15 @@ Status: Downloaded newer image for yangfangs/physpetree:v0.3.4
REPOSITORY TAG IMAGE ID CREATED SIZE
yangfangs/physpetree v0.3.4 ebcdaff79f7c 41 hours ago 683MB
```
### 3. run PhySpeTree image
### 4. run PhySpeTree image

* You need to run docker with an interactive bash and mount it in a local directory with a working directory in docker (PhySpeTree_work_dir).

```bash
[yangfang@localhost ~]$ docker run -it -v /home/yangfang/work_dir/:/PhySpeTree_work_dir yangfangs/physpetree:v0.3.4 bash
root@2d68776ac9ad:/PhySpeTree_work_dir#
```
### 3. Run PhySpeTree in Docker
### 5. Run PhySpeTree in Docker

* Download test file

Expand Down

0 comments on commit c00de11

Please sign in to comment.