Skip to content

Commit

Permalink
docs and errors
Browse files Browse the repository at this point in the history
  • Loading branch information
hasindu2008 committed Mar 1, 2024
1 parent e741017 commit a7baca9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/man.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Advanced options are as below:
- `--paf-ref`: in paf output, use the reference as the target instead of read (needs -c)
- `--cdna`: generate cDNA reads (only valid with dna profiles and the reference must a transcriptome, experimental)
- `--trans-count FILE`: simulate relative abundance using specified 2-column tsv with first column containing transcript name and the second containing the count (only for direct-rna and cDNA, experimental). You may generate this a test fatq dataset using minimap2, for example, `minimap2 -cx map-ont transcripts.fa reads.fastq --secondary=no -t20 -uf | cut -f 6 | sort | uniq -c | awk '{print$2"\t"$1}'`.
- `--trans-trunc=yes/no`: simulate transcript truncation (only for direct-rna and cDNA, experimental) [default: no]
- `--trans-trunc=yes/no`: simulate transcript truncation (only for direct-rna, experimental) [default: no]

Developer options (which are not much tested and error handling) are as below:

Expand Down
7 changes: 6 additions & 1 deletion src/sim.c
Original file line number Diff line number Diff line change
Expand Up @@ -682,7 +682,7 @@ static void print_help(FILE *fp_help, opt_t opt, profile_t p, int64_t nreads) {
fprintf(fp_help," --paf-ref in paf output, use the reference as the target instead of read (needs -c)\n");
fprintf(fp_help," --cdna generate cDNA reads (only valid with dna profiles and the reference must a transcriptome, experimental)\n");
fprintf(fp_help," --trans-count FILE simulate relative abundance using specified tsv with transcript name & count (only for direct-rna and cDNA, experimental)\n");
fprintf(fp_help," --trans-trunc=yes/no simulate transcript truncattion (only for direct-rna and cDNA, experimental) [no]\n");
fprintf(fp_help," --trans-trunc=yes/no simulate transcript truncattion (only for direct-rna, experimental) [no]\n");

fprintf(fp_help,"\ndeveloper options (not much tested yet):\n");
fprintf(fp_help," --digitisation FLOAT ADC digitisation [%.1f]\n",p.digitisation);
Expand Down Expand Up @@ -933,6 +933,11 @@ int sim_main(int argc, char* argv[], double realtime0) {
//check args
check_args(opt_gvn, rna, opt, paf);

if((opt.flag & SQ_CDNA) && (opt.flag & SQ_TRANS_TRUNC)){
ERROR("%s","Option --trans-trunc is not yet implemnted for --cdna.");
exit(EXIT_FAILURE);
}

if((opt.flag & SQ_CDNA) && (opt.flag & SQ_PREFIX)){
ERROR("%s","Option --prefix is not yet implemnted for --cdna.");
exit(EXIT_FAILURE);
Expand Down

0 comments on commit a7baca9

Please sign in to comment.