Skip to content

Commit db3172c

Browse files
committed
Mention fa.gz in documentation as input
1 parent aeb67a8 commit db3172c

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ se <- bambu(reads = sample1.bam, annotations = annotations, genome = fa.file, op
431431
|reads|A string or a vector of strings specifying the paths of bam files for genomic alignments, or a BamFile object or a BamFileList object (from Rsamtools).|
432432
| rcOutDir | A string variable specifying the path to where read class files will be saved. |
433433
| annotations | A TxDb object, a path to a .gtf file, or a GRangesList object obtained by prepareAnnotations. |
434-
| genome | A fasta file or a BSGenome object. |
434+
| genome | A fasta file or a BSGenome object. If a fa.gz is provided, the .fai and .gzi must also be present |
435435
| stranded | A boolean for strandedness, defaults to FALSE. |
436436
| ncore | specifying number of cores used when parallel processing is used, defaults to 1. |
437437
| NDR | specifying the maximum NDR rate to novel transcript output among detected transcripts, defaults to 0.1 |

0 commit comments

Comments
 (0)