Skip to content

Commit 85971d4

Browse files
committed
Update README.md
1 parent 42bb50f commit 85971d4

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ PrecisionProDB is a Python package for proteogenomics, which can generate a cust
2929
- [Benchmark](#benchmark)
3030
- [CPU/Memory consumption with 8 threads](#cpumemory-consumption-with-8-threads)
3131
- [Running time and required memory with different threads](#running-time-and-required-memory-with-different-threads)
32-
- [PrecisionProDB_references](#precisionprodb_references)
32+
- [PrecisionProDB\_references](#precisionprodb_references)
3333
- [Contact Information](#contact-information)
3434

3535

@@ -280,6 +280,11 @@ optional arguments:
280280

281281
```
282282

283+
**Notes**
284+
- `-p PROTEIN, --protein PROTEIN` is a file with proteins matching the GTF file provided!
285+
- `-k PROTEIN_KEYWORD` is a keyword used to match the GTF file and the protein sequences. If not provided, the program will try to determine the keyword based on the datatype. The program needs the data to know the location of proteins in the genome, and codon matches to allow non-standard codons.
286+
- `-a {GENCODE_GTF,GENCODE_GFF3,RefSeq,Ensembl_GTF,gtf}, --datatype {GENCODE_GTF,GENCODE_GFF3,RefSeq,Ensembl_GTF,gtf}` should be set if you use the format above. For "gtf" format, the `PROTEIN_KEYWORD` and `PROTEIN` should match.
287+
283288
# Outputs
284289
For more information, visit the [wiki](https://github.com/ATPs/PrecisionProDB/wiki) page.
285290
https://github.com/ATPs/PrecisionProDB/wiki

0 commit comments

Comments
 (0)