Skip to content

Commit ec807cf

Browse files
committedMar 5, 2021
minor Markdown cleanup
1 parent 5f67c01 commit ec807cf

File tree

3 files changed

+3
-15
lines changed

3 files changed

+3
-15
lines changed
 

‎Orthograph_Quality_Checker/README.md

+2-12
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
# Orthograph_Quality_Checker.py
22

3-
**Orthograph_Quality_Checker** performs a quality assessment of transcriptome assemblies based on orthology predictions with [Orthograph](https://github.com/mptrsen/Orthograph)[^1].
3+
**Orthograph_Quality_Checker** performs a quality assessment of transcriptome assemblies based on orthology predictions with [Orthograph](https://github.com/mptrsen/Orthograph)<sup>[1](#one)</sup>.
44

55
## System requirements
66

7-
---
8-
97
* Python 3.6.4 or newer
108
* Required Python modules: `argparse`, `Bio`, `operator`, `os`, `re`, `shutil`, `sys`
119

1210
## Parameters
1311

14-
---
15-
1612
The program has three parameters:
1713

1814
`-c/--config` (mandatory)
@@ -29,8 +25,6 @@ Setting `--reuse_tmp` allows you to re-use the summary files from a previous run
2925

3026
## The config file
3127

32-
---
33-
3428
The config file has to be in text format; any file suffix will do.
3529

3630
An example config file could look like this:
@@ -52,15 +46,11 @@ All paths have to be either absolute or relative to the location of `Orthograph_
5246

5347
## Data preparation
5448

55-
---
56-
5749
In order for the program to work properly, the structure of the directory tree in the directory specified using the tag `ORTHOGRAPH=` has to look like this:
5850
`ORTHOGRAPH/ASSEMBLER/TAXON/aa`
5951

6052
## The output
6153

62-
---
63-
6454
The final output is a tab-separated spreadsheet file (`Summarized_Orthograph_results.tsv`) that can be opened in a text editor or a spreadsheet editor like Excel.
6555
The first column in the file contains the taxon names. The following fields in the same row each correspond to one assembly of this taxon.
6656

@@ -73,4 +63,4 @@ There are four values in each of those fields:
7363

7464
---
7565

76-
[^1] Petersen, M., Meusemann, K., Donath, A. et al. Orthograph: a versatile tool for mapping coding nucleotide sequences to clusters of orthologous genes. BMC Bioinformatics 18, 111 (2017). [https://doi.org/10.1186/s12859-017-1529-8](https://doi.org/10.1186/s12859-017-1529-8)
66+
<a name="one">[1]</a> Petersen, M., Meusemann, K., Donath, A. et al. Orthograph: a versatile tool for mapping coding nucleotide sequences to clusters of orthologous genes. BMC Bioinformatics 18, 111 (2017). [https://doi.org/10.1186/s12859-017-1529-8](https://doi.org/10.1186/s12859-017-1529-8)

‎Remove_outliers/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ If not already present, the script will create a directory `aa_outliers_removed/
1919

2020
---
2121

22-
[^1] [https://github.com/alexdonath/checker_complete-v2](https://github.com/alexdonath/checker_complete-v2)
22+
<a name="one">[1]</a> [https://github.com/alexdonath/checker_complete-v2](https://github.com/alexdonath/checker_complete-v2)

‎Remove_reference_sequences/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,12 @@ The script removes all sequences belonging to reference species from the alignme
99

1010
## Other requirements
1111

12-
1312
The script has to be in the same directory as the files from which the reference sequences are to be removed.
1413

1514
Note that input files have to have the ending `.fas[ta]`.
1615

1716
## Output
1817

19-
2018
It will automatically create a subdirectory named `no_refseqs/`, in which the modified files will be saved.
2119

2220
---

0 commit comments

Comments
 (0)
Please sign in to comment.