You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -541,7 +541,7 @@ Currently, there is no plan for R compatibility. Try to convert R objects into A
541
541
```
542
542
If `X_pca` is not detected in `.obsm` and no other latent representations are provided via `use_rep`, gene expression matrix in `.X` will be used to calculate the distances. In such case, subsetting the AnnData to informative genes (e.g. highly variable genes) is suggested and `.X` should be log-normalised (to a constant total count per cell).
543
543
544
-
The resulting `alignment` is an instance of the class `DistanceAlignment` as defined by CellTypist, and can be written out as follows.
544
+
The resulting `alignment` is an instance of the class [DistanceAlignment](https://celltypist.readthedocs.io/en/latest/celltypist.contro.align.DistanceAlignment.html) as defined by CellTypist, and can be written out as follows.
A distance matrix-like instance, which is from the class `Distance` as defined by CellTypist, is also stashed in `alignment` as the attribute `.base_distance`.
656
+
A distance matrix-like instance, which is from the class [Distance](https://celltypist.readthedocs.io/en/latest/celltypist.contro.distance.Distance.html) as defined by CellTypist, is also stashed in `alignment` as the attribute `.base_distance`.
657
657
```python
658
658
#Access the distance object.
659
659
alignment.base_distance
@@ -690,7 +690,7 @@ Currently, there is no plan for R compatibility. Try to convert R objects into A
690
690
691
691
Along the order of datasets, optimal choices of `minimum_unique_percents` and `minimum_divide_percents` (see `1.4.`) in each iteration can be found in `alignment.minimum_unique_percents` and `alignment.minimum_divide_percents`. For instance, harmonising five datasets requires four iterations, and thus both `.minimum_unique_percents` and `.minimum_divide_percents` have a length of four.
692
692
693
-
CellTypist provides a method `.best_align()` to change the order of datasets post-harmonisation. Through this, datasets will be reharmonised in a different order (this post-harmonisation adjustment is more efficient than re-running `celltypist.harmonize` with a new order).
693
+
CellTypist provides a method [best_align](https://celltypist.readthedocs.io/en/latest/celltypist.contro.align.DistanceAlignment.html#celltypist.contro.align.DistanceAlignment.best_align) to change the order of datasets post-harmonisation. Through this, datasets will be reharmonised in a different order (this post-harmonisation adjustment is more efficient than re-running `celltypist.harmonize` with a new order).
694
694
```python
695
695
#Reharmonise cell types across datasets with a different dataset order.
After changing the dataset order and reharmonising cell types, cells need to be reannotated based on the newly generated harmonisation table using the method `reannotate`.
709
+
After changing the dataset order and reharmonising cell types, cells need to be reannotated based on the newly generated harmonisation table using the method [reannotate](https://celltypist.readthedocs.io/en/latest/celltypist.contro.align.DistanceAlignment.html#celltypist.contro.align.DistanceAlignment.reannotate).
710
710
```python
711
711
#Reannotate cells based on the new harmonisation table.
0 commit comments