stereo.io.write_h5ad#
- stereo.io.write_h5ad(data, use_raw=True, use_result=True, key_record=None, output=None, split_batches=True)[source]#
Write the StereoExpData into a H5ad file.
- Parameters:
data (
StereoExpData
) – the input StereoExpData object.use_raw (
bool
) – whether to save raw data.use_result (
bool
) – whether to saveresult
andres_key
.key_record (
Optional
[dict
]) – a dict includes selectiveres_key
with the precondition thatuse_result
isTrue
, if None, it will save theresult
andres_key
ofdata.tl.key_record
,otherwise it will save the result and res_key of the dict.output (
Optional
[str
]) – the path to output file.split_batches (
bool
) – Whether to save each batch to a single file if it is a merged data, default to True.
- Return type:
None