Update Cell Clusters
The Update Cell Clusters tool takes one Cell Clusters () element as input and outputs a new Cell Clusters () element containing updated categories and/or clusters.The tool can be found in the Toolbox here:
Toolbox | Single Cell Analysis () | Utility Tools () | Update Cell Clusters ()
In the first wizard step `Update categories', the following options can be adjusted:
- Remove categories. The selected categories are removed.
- Remove all empty categories. Categories without any clusters are removed. Categories are also removed if empty after removal of clusters (see below).
- Rename categories. One or more categories are renamed. The Add button can be used to add additional categories to be renamed. Note that multiple categories cannot be renamed to the same name.
- Rename all categories. All categories are renamed according to the given pattern. This can be used for both prepending and appending to the name. E.g., if set to `MyPrefix {categoryName} MySuffix', a category `MyCategory' will be renamed to `MyPrefix MyCategory MySuffix'. This is done after the changes specified by Rename categories.
In the next wizard step `Update clusters', the clusters can be updated. The following options can be adjusted:
- Update clusters for. The updates can be applied to:
- No categories. Skip updating clusters.
- All categories. Update the clusters for all categories.
- Selected category. Update the clusters only for the category selected in Update clusters for category.
- Remove clusters. The selected clusters are removed.
- Remove all empty clusters. Clusters with no cells are removed.
- Rename clusters. One or more clusters are renamed. The Add button can be used to add additional clusters to be renamed.
- Map clusters to QIAGEN Cell Ontology. When this is checked, clusters will be translated, if possible, to the QIAGEN Cell Ontology (see The QIAGEN Cell Ontology). The translation attempts to match each cluster with a QIAGEN cell type based on the name and known synonyms. For example, `alveolar epithelial cells' are also called `pneumocytes'. If this option is selected, the `alveolar epithelial cells' cluster, if present, will be named `pneumocytes'. This option can be useful when standardizing clusters from different sources. It is especially recommended if clusters will be used to extend a QIAGEN Cell Type Classifier using the Train Cell Type Classifier tool (Train Cell Type Classifier).
If two distinct clusters are given the same name, they are combined into one. This can happen if:
- A cluster is renamed to an existing name.
- Two clusters are renamed to the same name.
- Two cluster names are synonyms for the same QIAGEN cell type and clusters are mapped to the ontology.
The options above can be mixed and matched to obtain the desired output. For example, a cluster can be first renamed and then the new name can be mapped to the ontology.
The Update Cell Clusters tool can also be started from the different views of the Cell Clusters () element, with dialogs automatically filled in with relevant selections:
- From the clusters table view ():
- Clusters can be removed or renamed from the right-click menu. Multiple rows can be selected before using the right-click menu.
- A category can be removed or renamed using the Remove and Rename buttons from the Side Panel.
- From the cell-level view (), the category over which the mouse hovers can be removed or renamed from the right-click menu.