Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
timoast committed Jul 22, 2024
1 parent 782cbeb commit f5fd52b
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ fn main() -> Result<(), Box<dyn Error>> {
let matches = Command::new("f2m")
.version("0.1")
.author("Tim Stuart")
.about("Create a cell x feature matrix")
.about("Fragments to matrix: create a feature x cell matrix from a fragment file")
.arg(
Arg::new("fragments")
.short('f')
Expand All @@ -41,21 +41,22 @@ fn main() -> Result<(), Box<dyn Error>> {
Arg::new("bed")
.short('b')
.long("bed")
.help("BED file containing regions to quantify")
.help("BED file containing non-overlapping genomic regions to quantify")
.required(true),
)
.arg(
Arg::new("cells")
.short('c')
.long("cells")
.help("List of cells to include")
.help("File containing cell barcodes to include")
.required(true),
)
.arg(
Arg::new("outdir")
.short('o')
.long("outdir")
.help("Output directory name")
.help("Output directory name. Directory will be created if it does not exist.
The output directory will contain matrix.mtx.gz, features.tsv, barcodes.tsv")
.required(true),
)
.arg(
Expand Down

0 comments on commit f5fd52b

Please sign in to comment.