stereo.io.mudata_to_msdata

stereo.io.mudata_to_msdata(file_path=None, sample_names=None, scope_names=None, entire_merged_data_name=None)[source]

Read a h5mu file and convert it to a MSData object.

Parameters:

  • file_path (Optional[str]) – The path of the MuData file, defaults to None

  • sample_names (Union[ndarray, List[str], None]) – The names of single samples that are saved in the MuData object, defaults to None, if None, the names starting with ‘sample_’ will be used.

  • scope_names (Union[ndarray, List[str], None]) – The names of merged samples that are saved in the MuData object, defaults to None, if None, the names like ‘scope_[0,1,2]’ will be used.

  • entire_merged_data_name (Optional[str]) – The name of the merged sample which is merged from all samples, default to None, if None, use the one like ‘scope_[0,1,2]’ whose square brackets contain index sequence of all samples.

Returns:

The MSData object.

Note

You need to install the mudata package before using this function:

pip install mudata