Skip to content

mcmicro_to_scimap

Short Description

sm.pp.mcmicro_to_scimap: The function allows users to directly import the output from mcmicro into scimap.

Function

mcmicro_to_scimap(feature_table_path, remove_dna=True, remove_string_from_name=None, log=True, drop_markers=None, random_sample=None, unique_CellId=True, CellId='CellID', split='X_centroid', custom_imageid=None, min_cells=None, verbose=True, output_dir=None)

Parameters:

Name Type Description Default
feature_table_path list of str

A list containing file paths to single-cell spatial feature tables. Each path corresponds to a unique image's feature table.

 required
remove_dna bool

If set to True, channels identified by containing the substring 'dna' are excluded from the final dataset. This parameter is useful for omitting DNA-related features.

 True
remove_string_from_name str

Specifies a substring to be removed from all channel names, aiding in the normalization of marker names across datasets.

 None
log bool

If True, applies a log transformation (specifically log1p, which adds 1 before taking the logarithm) to the data. This is often used to normalize data distributions.

 True
drop_markers list of str

A list of marker names to exclude from the analysis. For example, to remove specific markers, you would list them here: ["CD3D", "CD20"].

 None
random_sample int

Specifies the number of cells to include in a subsampled dataset. This parameter is used for downsampling to a specified cell count.

 None
CellId str

The name of the column in the input data that contains cell identifiers. This is used to track individual cells across analyses.

 'CellID'
unique_CellId bool

Determines whether to automatically generate a unique identifier for each cell by combining the CellId with an imageid. Set to False to use the original CellId values directly. This is crucial for maintaining unique cell identifiers, especially when integrating multiple datasets.

 True
split str

The name of the column that demarcates the boundary between quantitative marker data and additional metadata in the input CSV. Specifying this column allows for the separation of data into counts and metadata components.

 'X_centroid'
custom_imageid str

Allows for the specification of a custom Image ID for each dataset. By default, the Image ID is derived from the name of the input CSV file.

 None
min_cells int

Sets a threshold for the minimum number of cells required for an image to be included in the analysis. Images with fewer cells than this number are excluded. This is useful for filtering out datasets with sparse cellular data.

 None
verbose bool

If set to True, the function will print detailed messages about its progress and the steps being executed.

 True
output_dir str

The file path to the directory where output files will be saved. This parameter specifies the destination for any generated files.

 None

Returns:

Type Description

AnnData Object (anndata): An annotated data object containing the processed single-cell spatial features, ready for downstream analysis.
Example 
1
2
3
4
feature_table_path = ['/Users/aj/scimapExampleData/quantification/exemplar-001--unmicst_cell.csv',
                      '/Users/aj/scimapExampleData/quantification/exemplar-002--unmicst_cell.csv']

adata = sm.pp.mcmicro_to_scimap(feature_table_path, drop_markers=['ELANE'], random_sample=5000)
Source code in scimap/preprocessing/mcmicro_to_scimap.py 
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
def mcmicro_to_scimap(
    feature_table_path,
    remove_dna=True,
    remove_string_from_name=None,
    log=True,
    drop_markers=None,
    random_sample=None,
    unique_CellId=True,
    CellId='CellID',
    split='X_centroid',
    custom_imageid=None,
    min_cells=None,
    verbose=True,
    output_dir=None,
):
    """
    Parameters:
        feature_table_path (list of str):
            A list containing file paths to single-cell spatial feature tables. Each path corresponds to a unique image's feature table.

        remove_dna (bool):
            If set to `True`, channels identified by containing the substring 'dna' are excluded from the final dataset. This parameter is useful for omitting DNA-related features.

        remove_string_from_name (str):
            Specifies a substring to be removed from all channel names, aiding in the normalization of marker names across datasets.

        log (bool):
            If `True`, applies a log transformation (specifically log1p, which adds 1 before taking the logarithm) to the data. This is often used to normalize data distributions.

        drop_markers (list of str):
            A list of marker names to exclude from the analysis. For example, to remove specific markers, you would list them here: ["CD3D", "CD20"].

        random_sample (int):
            Specifies the number of cells to include in a subsampled dataset. This parameter is used for downsampling to a specified cell count.

        CellId (str):
            The name of the column in the input data that contains cell identifiers. This is used to track individual cells across analyses.

        unique_CellId (bool):
            Determines whether to automatically generate a unique identifier for each cell by combining the `CellId` with an `imageid`. Set to `False` to use the original `CellId` values directly. This is crucial for maintaining unique cell identifiers, especially when integrating multiple datasets.

        split (str):
            The name of the column that demarcates the boundary between quantitative marker data and additional metadata in the input CSV. Specifying this column allows for the separation of data into counts and metadata components.

        custom_imageid (str):
            Allows for the specification of a custom Image ID for each dataset. By default, the Image ID is derived from the name of the input CSV file.

        min_cells (int):
            Sets a threshold for the minimum number of cells required for an image to be included in the analysis. Images with fewer cells than this number are excluded. This is useful for filtering out datasets with sparse cellular data.

        verbose (bool):
            If set to `True`, the function will print detailed messages about its progress and the steps being executed.

        output_dir (str):
            The file path to the directory where output files will be saved. This parameter specifies the destination for any generated files.


    Returns:
        AnnData Object (anndata):
            An annotated data object containing the processed single-cell spatial features, ready for downstream analysis.


    Example:
            ```

            feature_table_path = ['/Users/aj/scimapExampleData/quantification/exemplar-001--unmicst_cell.csv',
                                  '/Users/aj/scimapExampleData/quantification/exemplar-002--unmicst_cell.csv']

            adata = sm.pp.mcmicro_to_scimap(feature_table_path, drop_markers=['ELANE'], random_sample=5000)

            ```

    """

    # feature_table_path list or string
    if isinstance(feature_table_path, str):
        feature_table_path = [feature_table_path]
    feature_table_path = [pathlib.Path(p) for p in feature_table_path]

    # Import data based on the location provided
    def load_process_data(image):
        # Print the data that is being processed
        if verbose:
            print(f"Loading {image.name}")
        d = pd.read_csv(image)
        # If the data does not have a unique image ID column, add one.
        if 'imageid' not in d.columns:
            if custom_imageid is not None:
                imid = custom_imageid
            else:
                # imid = random.randint(1000000,9999999)
                imid = image.stem
            d['imageid'] = imid
        # Unique name for the data
        if unique_CellId is True:
            d.index = d['imageid'].astype(str) + '_' + d[CellId].astype(str)
        else:
            d.index = d[CellId]

        # move image id and cellID column to end
        cellid_col = [col for col in d.columns if col != CellId] + [CellId]
        d = d[cellid_col]
        imageid_col = [col for col in d.columns if col != 'imageid'] + ['imageid']
        d = d[imageid_col]
        # If there is INF replace with zero
        d = d.replace([np.inf, -np.inf], 0)
        # Return data
        return d

    # Apply function to all images and create a master dataframe
    r_load_process_data = lambda x: load_process_data(image=x)  # Create lamda function
    all_data = list(
        map(r_load_process_data, list(feature_table_path))
    )  # Apply function

    # Merge all the data into a single large dataframe
    for i in range(len(all_data)):
        all_data[i].columns = all_data[0].columns
    entire_data = pd.concat(all_data, axis=0, sort=False)

    # Randomly sample the data
    if random_sample is not None:
        entire_data = entire_data.sample(n=random_sample, replace=False)

    # Remove the images that contain less than a defined threshold of cells (min_cells)
    if min_cells is not None:
        to_drop = (
            entire_data['imageid']
            .value_counts()[entire_data['imageid'].value_counts() < min_cells]
            .index
        )
        entire_data = entire_data[~entire_data['imageid'].isin(to_drop)]
        print(
            'Removed Images that contained less than '
            + str(min_cells)
            + ' cells: '
            + str(to_drop.values)
        )

    # Split the data into expression data and meta data
    # Step-1 (Find the index of the column with name Area)
    split_idx = entire_data.columns.get_loc(split)
    meta = entire_data.iloc[:, split_idx:]
    # Step-2 (select only the expression values)
    entire_data = entire_data.iloc[:, :split_idx]

    # Rename the columns of the data
    if remove_string_from_name is not None:
        entire_data.columns = entire_data.columns.str.replace(
            remove_string_from_name, ''
        )

    # Save a copy of the column names in the uns space of ANNDATA
    markers = list(entire_data.columns)

    # Remove DNA channels
    if remove_dna is True:
        entire_data = entire_data.loc[
            :, ~entire_data.columns.str.contains('dna', case=False)
        ]

    # Drop unnecessary markers
    if drop_markers is not None:
        if isinstance(drop_markers, str):
            drop_markers = [drop_markers]
        entire_data = entire_data.drop(columns=drop_markers)

    # Create an anndata object
    adata = ad.AnnData(entire_data)
    adata.obs = meta
    adata.uns['all_markers'] = markers

    # Add log data
    if log is True:
        adata.raw = adata
        adata.X = np.log1p(adata.X)
        adata.layers['log'] = np.log1p(adata.X)

    # Save data if requested
    if output_dir is not None:
        output_dir = pathlib.Path(output_dir)
        output_dir.mkdir(exist_ok=True, parents=True)
        imid = feature_table_path[0].stem
        adata.write(output_dir / f'{imid}.h5ad')
        # adata.write(str(output_dir) + '/' + imid + '.h5ad')
    else:
        # Return data
        return adata