Skip to content

Commit 2ffec80

Browse files
committed
update doc
1 parent 303a9f3 commit 2ffec80

File tree

3 files changed

+17
-3
lines changed

3 files changed

+17
-3
lines changed

docs/docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Ribosomal protein S13 | K02953 | K02
7070
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.
7171

7272

73-
## 5. How do I use PhySpeTree when I can't connect to the Internet?
73+
### 5. How do I use PhySpeTree when I can't connect to the Internet?
7474

7575
When users can't connect to the Internet. They can download the HCP or SSU rRNA database to local and reconstruct species tree.
7676

docs/docs/usage.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -475,6 +475,7 @@ $ PhySpeTree combine -i combineTree.tree [options]*
475475
| --mre | Extended majority rule trees. |
476476
| --strict | Strict consensus trees. |
477477
| --astral | Use ASTRAL combine multi gene tree. |
478+
478479
### Example
479480

480481
[example_combine_tree.tar.gz][5] contains `tree1.tree` and `tree2.tree` reconstructed by the HCP and SSU rRNA method, respectively.
@@ -516,7 +517,7 @@ PhySpeTree combine -i combine.tree -o combineTree
516517
```
517518

518519
Outputs:
519-
update PhySpeTree work follow fig
520+
520521
```
521522
combine/
522523
RAxML_info.T1
@@ -526,6 +527,19 @@ combine/
526527
* `RAxML_info.T1`: logs in running RAxML.
527528
* `RAxML_MajorityRuleConsensusTree.T1`: the majority rule consensus tree.
528529

530+
### Using `--astral`
531+
> Notice: The `--astral` option call the third-party software ASTRAL. Keeping the JRE was
532+
> installed in your environment(if not used PhySpeTree in Docker environment).
533+
534+
```bash
535+
PhySpeTree combine -i combine.tree -o combineTree --astral
536+
```
537+
Outputs:
538+
539+
```
540+
combineTree/
541+
combine.tree
542+
```
529543
## iview
530544

531545
PhySpeTree provides the `iview` module to annotate taxonomic information (kingdom, phylum, class, or order) of output trees and to generate configure files linked to [iTol](http://itol.embl.de/).

physpetool/phylotree/consensustree.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,5 +50,5 @@ def do_astral(input,output):
5050
if not os.path.exists(output):
5151
os.mkdir(output)
5252
out_name = "combine.tree"
53-
consensuseCmd = "java -jar " + astralpath + "/astral.5.6.3.jar" + " -i " + input+" -o " + output + out_name
53+
consensuseCmd = "java -jar " + astralpath + "/astral.5.6.3.jar" + " -i " + input+" -o " + output +"/"+ out_name
5454
subprocess.call(consensuseCmd, shell=True)

0 commit comments

Comments
 (0)