Skip to content

Commit 3cbf48b

Browse files
author
Rob Patro
committed
formatting
1 parent 69cb2e0 commit 3cbf48b

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -282,13 +282,15 @@ The `convert` sub-command of `pyroe` can convert the output of `alevin-fry` into
282282
the native `AnnData` format (`h5ad`). Further, when performing this conversion, it can organize the unspliced,
283283
spliced, and ambiguous counts as desired by the user.
284284

285-
The sub-command takes as input a quantification directory produced by `alevin-fry`, an output structure,
286-
an output format, and an output location. The output structure defines how the `U`, `S`, and `A` layers
287-
of the input quantification should be represented in the converted matrix. The syntax for this flag exactly
288-
mimics the `output_format` argument of the `load_fry` function, which you can read about [here](https://github.com/COMBINE-lab/pyroe#load_fry-notes). Note that, if you pass in a custom output structure, you should enclose
289-
your format description in quotes. For example, to output to an object where the "main" layer (`X`) contains
290-
the sum of `U`, `S`, and `A`, and where there is an additional layer named `unspliced` having just the
291-
unspliced counts, you would pass `--output-structure '{ "X" : ["U", "S", "A"], "unspliced" : ["U"]}'`.
285+
The sub-command takes as input a quantification directory produced by `alevin-fry`, and an output location.
286+
Additionally, the user should pass in command line parameters to describe the desired output structure, and
287+
output format. The output structure defines how the `U`, `S`, and `A` layers of the input quantification should
288+
be represented in the converted matrix. The syntax for this flag exactly mimics the `output_format` argument of
289+
the `load_fry` function, which you can read about [here](https://github.com/COMBINE-lab/pyroe#load_fry-notes).
290+
Note that, if you pass in a custom output structure, you should enclose your format description in quotes. For
291+
example, to output to an object where the "main" layer (`X`) contains the sum of `U`, `S`, and `A`, and where
292+
there is an additional layer named `unspliced` having just the unspliced counts, you would pass
293+
`--output-structure '{ "X" : ["U", "S", "A"], "unspliced" : ["U"]}'`.
292294

293295
If you do not explicitly provide an `--output-format`, the default of `h5ad` will be used.
294296

0 commit comments

Comments
 (0)