diff --git a/README.md b/README.md index 7639ef5d..f8201a5a 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,16 @@ The general workflow for generating the statistics and report is as follows:
@@ -39,7 +49,7 @@ Expected inputs: ``` -p / --panel_bed : Input panel bed file; must have ONLY the following 4 columns chromosome, start position, end position, gene/transcript --t / --transcript_file : Transcript annotation file, contains required gene and exon information. must have ONLY the following 6 columns: +-t / --transcript_file : Transcript annotation file, contains required gene and exon information. Must have ONLY the following 6 columns: chromosome, start, end, gene, transcript, exon -c / --coverage_file : Per base coverage file (output from mosdepth or similar) @@ -115,13 +125,6 @@ $ python3 bin/coverage_report_single.py --gene_stats output/sample1-exon-coverag ``` -### For development - -Features to be developed: -- Generate run level statistics from multiple samples -- Generate run level report from multiple samples -- Add interactive elements to tables to increase useability (i.e sorting, filtering, searching) - Any bugs or suggestions for improvements please raise an issue. @@ -137,3 +140,4 @@ Any bugs or suggestions for improvements please raise an issue. [mosdepth-url]: https://github.com/brentp/mosdepth [dx-url]: https://github.com/eastgenomics/eggd_athena +[transcript-file-url]: https://cuhbioinformatics.atlassian.net/wiki/spaces/P/pages/2241101840/Generating+transcripts+file+for+Athena