Skip to content

Commit bdfb96c

Browse files
committed
Update method links in README
1 parent 864c802 commit bdfb96c

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -541,7 +541,7 @@ Currently, there is no plan for R compatibility. Try to convert R objects into A
541541
```
542542
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).
543543

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.
545545
```python
546546
#Save the harmonisation output.
547547
alignment.write('/path/to/local/folder/some_name.pkl')
@@ -653,7 +653,7 @@ Currently, there is no plan for R compatibility. Try to convert R objects into A
653653
+ <details>
654654
<summary><strong>2.3. Meta-analysis</strong></summary>
655655

656-
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`.
657657
```python
658658
#Access the distance object.
659659
alignment.base_distance
@@ -690,7 +690,7 @@ Currently, there is no plan for R compatibility. Try to convert R objects into A
690690

691691
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.
692692

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).
694694
```python
695695
#Reharmonise cell types across datasets with a different dataset order.
696696
alignment.best_align(dataset_order = a_list_of_new_dataset_order)
@@ -706,7 +706,7 @@ Currently, there is no plan for R compatibility. Try to convert R objects into A
706706
+ <details>
707707
<summary><strong>3.2. Reannotation</strong></summary>
708708

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`.
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).
710710
```python
711711
#Reannotate cells based on the new harmonisation table.
712712
alignment.reannotate()

0 commit comments

Comments
 (0)