From ae4d3293403c6371c5865f4e5188a1a43bf097f1 Mon Sep 17 00:00:00 2001 From: "hugo.madgeleon" <hugo.madgeleon@stud.unibas.ch> Date: Wed, 21 Dec 2022 11:13:04 +0100 Subject: [PATCH] changes to README --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ad5d349..6b914a4 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,16 @@ As a whole project, we implemented a procedure for sampling reads from mRNA sequ # Usage -Input: -- fasta_file -- counts_file -- sep +CLI arguments: +- fasta (required): Path to FASTA file with cDNA sequences +- counts (required): Path to CSV/TSV file with sequence counts +- output (required): Output file path + +- mean: Mean fragment length (default: 300) +- std: Standard deviation fragment length (default: 60) +- size: Chunk size for batch processing (default: 10000) +- sep: Sequence counts file separator (default: ",") + """Takes as input FASTA file of cDNA sequences, a CSV/TSV with sequence counts, and mean and std. dev. of fragment lengths. Outputs most terminal fragment (within desired length range) for each sequence.""" Output: -- GitLab