Skip to content

Commit

Permalink
correct the format
Browse files Browse the repository at this point in the history
  • Loading branch information
yihming committed Mar 9, 2022
1 parent 88aa343 commit 28e1a29
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions pegasusio/readwrite.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ def read_input(
) -> MultimodalData:
"""Load data into memory.
This function is used to load input data into memory. Inputs can be in 'zarr', 'h5ad', 'loom', '10x', 'mtx', 'csv', 'tsv', 'fcs' (for flow/mass cytometry data) or 'nanostring' (Nanostring GeoMx spatial data) formats.
Parameters
----------
input_file : `str`
Expand All @@ -121,9 +122,11 @@ def read_input(
Only select data with genomes in select_genome. Select_data, select_genome and select_modality are mutually exclusive.
select_modality: `Set[str]`, optional (default: None)
Only select data with modalities in select_modality. Select_data, select_genome and select_modality are mutually exclusive.
Returns
-------
A MultimodalData object.
Examples
--------
>>> data = io.read_input('example_10x.h5')
Expand Down Expand Up @@ -190,6 +193,7 @@ def write_output(
) -> None:
""" Write data back to disk.
This function is used to write data back to disk.
Parameters
----------
data : MutimodalData
Expand All @@ -202,9 +206,11 @@ def write_output(
Only used for writing out SCP-compatible files, if write expression as a sparse matrix.
precision : `int`, optional (default: 2)
Precision after decimal point for values in mtx and scp expression matrix.
Returns
-------
`None`
Examples
--------
>>> io.write_output(data, 'test.zarr')
Expand Down

0 comments on commit 28e1a29

Please sign in to comment.