diff --git a/src/control_methods/true_proportions/config.vsh.yaml b/src/control_methods/true_proportions/config.vsh.yaml index 7cae84d..ba76b51 100644 --- a/src/control_methods/true_proportions/config.vsh.yaml +++ b/src/control_methods/true_proportions/config.vsh.yaml @@ -1,11 +1,11 @@ __merge__: ../../api/comp_control_method.yaml name: true_proportions +label: True Proportions +summary: "Positive control method that assigns celltype proportions from the ground truth." +description: | + A positive control method with perfect assignment of predicted celltype proportions from the ground truth. info: - label: True Proportions - summary: "Positive control method that assigns celltype proportions from the ground truth." - description: | - A positive control method with perfect assignment of predicted celltype proportions from the ground truth. preferred_normalization: counts resources: diff --git a/src/methods/cell2location/config.vsh.yaml b/src/methods/cell2location/config.vsh.yaml index be96c02..68d6b9e 100644 --- a/src/methods/cell2location/config.vsh.yaml +++ b/src/methods/cell2location/config.vsh.yaml @@ -1,13 +1,17 @@ __merge__: ../../api/comp_method.yaml name: cell2location - +label: Cell2Location +summary: "Cell2location uses a Bayesian model to resolve cell types in spatial transcriptomic data and create comprehensive cellular maps of diverse tissues." +description: | + Cell2location is a decomposition method based on Negative Binomial regression that is able to account for batch effects in estimating the single-cell gene expression signature used for the spatial decomposition step. + Note that when batch information is unavailable for this task, we can use either a hard-coded reference, or a negative-binomial learned reference without batch labels. The parameter alpha refers to the detection efficiency prior. +references: + doi: 10.1038/s41587-021-01139-4 +links: + documentation: https://cell2location.readthedocs.io/en/latest/ + repository: https://github.com/BayraktarLab/cell2location info: - label: Cell2Location - summary: "Cell2location uses a Bayesian model to resolve cell types in spatial transcriptomic data and create comprehensive cellular maps of diverse tissues." - description: | - Cell2location is a decomposition method based on Negative Binomial regression that is able to account for batch effects in estimating the single-cell gene expression signature used for the spatial decomposition step. - Note that when batch information is unavailable for this task, we can use either a hard-coded reference, or a negative-binomial learned reference without batch labels. The parameter alpha refers to the detection efficiency prior. preferred_normalization: counts variants: cell2location_amortised_detection_alpha_20: @@ -22,9 +26,6 @@ info: hard_coded_reference: false cell2location_detection_alpha_200: detection_alpha: 200 - reference: "kleshchevnikov2022cell2location" - documentation_url: https://cell2location.readthedocs.io/en/latest/ - repository_url: https://github.com/BayraktarLab/cell2location # Component-specific parameters (optional) arguments: diff --git a/src/methods/destvi/config.vsh.yaml b/src/methods/destvi/config.vsh.yaml index e27d8a9..8390e4b 100644 --- a/src/methods/destvi/config.vsh.yaml +++ b/src/methods/destvi/config.vsh.yaml @@ -1,15 +1,17 @@ __merge__: ../../api/comp_method.yaml name: destvi +label: DestVI +summary: "DestVI is a probabilistic method for multi-resolution analysis for spatial transcriptomics that explicitly models continuous variation within cell types" +description: | + Deconvolution of Spatial Transcriptomics profiles using Variational Inference (DestVI) is a spatial decomposition method that leverages a conditional generative model of spatial transcriptomics down to the sub-cell-type variation level, which is then used to decompose the cell-type proportions determining the spatial organization of a tissue. +references: + doi: 10.1038/s41587-022-01272-8 +links: + documentation: https://docs.scvi-tools.org/en/stable/user_guide/models/destvi.html + repository: https://github.com/scverse/scvi-tools info: - label: DestVI - summary: "DestVI is a probabilistic method for multi-resolution analysis for spatial transcriptomics that explicitly models continuous variation within cell types" - description: | - Deconvolution of Spatial Transcriptomics profiles using Variational Inference (DestVI) is a spatial decomposition method that leverages a conditional generative model of spatial transcriptomics down to the sub-cell-type variation level, which is then used to decompose the cell-type proportions determining the spatial organization of a tissue. preferred_normalization: counts - reference: "lopez2022destvi" - documentation_url: https://docs.scvi-tools.org/en/stable/user_guide/models/destvi.html - repository_url: https://github.com/scverse/scvi-tools arguments: - name: "--max_epochs_sc" diff --git a/src/methods/nmfreg/config.vsh.yaml b/src/methods/nmfreg/config.vsh.yaml index 3533f08..af8aab9 100644 --- a/src/methods/nmfreg/config.vsh.yaml +++ b/src/methods/nmfreg/config.vsh.yaml @@ -1,15 +1,17 @@ __merge__: ../../api/comp_method.yaml name: nmfreg +label: NMFreg +summary: "NMFreg reconstructs gene expression as a weighted combination of cell type signatures defined by scRNA-seq." +description: | + Non-Negative Matrix Factorization regression (NMFreg) is a decomposition method that reconstructs expression of each spatial location as a weighted combination of cell-type signatures defined by scRNA-seq. It was originally developed for Slide-seq data. This is a re-implementation from https://github.com/tudaga/NMFreg_tutorial. info: - label: NMFreg - summary: "NMFreg reconstructs gene expression as a weighted combination of cell type signatures defined by scRNA-seq." - description: | - Non-Negative Matrix Factorization regression (NMFreg) is a decomposition method that reconstructs expression of each spatial location as a weighted combination of cell-type signatures defined by scRNA-seq. It was originally developed for Slide-seq data. This is a re-implementation from https://github.com/tudaga/NMFreg_tutorial. preferred_normalization: counts - reference: "rodriques2019slide" - documentation_url: https://scikit-learn.org/stable/modules/generated/sklearn.decomposition.NMF.html - repository_url: https://github.com/tudaga/NMFreg_tutorial/tree/master?tab=readme-ov-file +references: + doi: 10.1126/science.aaw1219 +links: + documentation: https://scikit-learn.org/stable/modules/generated/sklearn.decomposition.NMF.html + repository: https://github.com/tudaga/NMFreg_tutorial/tree/master?tab=readme-ov-file arguments: - name: "--n_components" diff --git a/src/methods/nnls/config.vsh.yaml b/src/methods/nnls/config.vsh.yaml index a9af655..15ba141 100644 --- a/src/methods/nnls/config.vsh.yaml +++ b/src/methods/nnls/config.vsh.yaml @@ -1,15 +1,17 @@ __merge__: ../../api/comp_method.yaml name: nnls +label: NNLS +summary: "NNLS is a decomposition method based on Non-Negative Least Square Regression." +description: | + NonNegative Least Squares (NNLS), is a convex optimization problem with convex constraints. It was used by the AutoGeneS method to infer cellular proporrtions by solvong a multi-objective optimization problem. info: - label: NNLS - summary: "NNLS is a decomposition method based on Non-Negative Least Square Regression." - description: | - NonNegative Least Squares (NNLS), is a convex optimization problem with convex constraints. It was used by the AutoGeneS method to infer cellular proporrtions by solvong a multi-objective optimization problem. preferred_normalization: counts - reference: "aliee2021autogenes" - documentation_url: https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.nnls.html - repository_url: https://github.com/scipy/scipy +reference: + doi: 10.1016/j.cels.2021.05.006 +links: + documentation: https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.nnls.html + repository: https://github.com/scipy/scipy resources: - type: python_script diff --git a/src/methods/rctd/config.vsh.yaml b/src/methods/rctd/config.vsh.yaml index 321e061..f465a1a 100644 --- a/src/methods/rctd/config.vsh.yaml +++ b/src/methods/rctd/config.vsh.yaml @@ -1,15 +1,17 @@ __merge__: ../../api/comp_method.yaml name: rctd +label: RCTD +summary: "RCTD learns cell type profiles from scRNA-seq to decompose cell type mixtures while correcting for differences across sequencing technologies." +description: | + RCTD (Robust Cell Type Decomposition) is a decomposition method that uses signatures learnt from single-cell data to decompose spatial expression of tissues. It is able to use a platform effect normalization step, which normalizes the scRNA-seq cell type profiles to match the platform effects of the spatial transcriptomics dataset. info: - label: RCTD - summary: "RCTD learns cell type profiles from scRNA-seq to decompose cell type mixtures while correcting for differences across sequencing technologies." - description: | - RCTD (Robust Cell Type Decomposition) is a decomposition method that uses signatures learnt from single-cell data to decompose spatial expression of tissues. It is able to use a platform effect normalization step, which normalizes the scRNA-seq cell type profiles to match the platform effects of the spatial transcriptomics dataset. preferred_normalization: counts - reference: cable2021robust - documentation_url: https://raw.githack.com/dmcable/spacexr/master/vignettes/spatial-transcriptomics.html - repository_url: https://github.com/dmcable/spacexr +references: + doi: 10.1038/s41587-021-00830-w +links: + documentation: https://raw.githack.com/dmcable/spacexr/master/vignettes/spatial-transcriptomics.html + repository: https://github.com/dmcable/spacexr arguments: - name: "--fc_cutoff" diff --git a/src/methods/seurat/config.vsh.yaml b/src/methods/seurat/config.vsh.yaml index 9c63222..ea3f01e 100644 --- a/src/methods/seurat/config.vsh.yaml +++ b/src/methods/seurat/config.vsh.yaml @@ -1,15 +1,17 @@ __merge__: ../../api/comp_method.yaml name: seurat +label: Seurat +summary: "Seurat method that is based on Canonical Correlation Analysis (CCA)." +description: | + This method applies the 'anchor'-based integration workflow introduced in Seurat v3, that enables the probabilistic transfer of annotations from a reference to a query set. First, mutual nearest neighbors (anchors) are identified from the reference scRNA-seq and query spatial datasets. Then, annotations are transfered from the single cell reference data to the sptial data along with prediction scores for each spot. info: - label: Seurat - summary: "Seurat method that is based on Canonical Correlation Analysis (CCA)." - description: | - This method applies the 'anchor'-based integration workflow introduced in Seurat v3, that enables the probabilistic transfer of annotations from a reference to a query set. First, mutual nearest neighbors (anchors) are identified from the reference scRNA-seq and query spatial datasets. Then, annotations are transfered from the single cell reference data to the sptial data along with prediction scores for each spot. preferred_normalization: counts - reference: stuart2019comprehensive - documentation_url: https://satijalab.org/seurat/articles/spatial_vignette - repository_url: https://github.com/satijalab/seurat +references: + doi: 10.1016/j.cell.2019.05.031 +links: + documentation: https://satijalab.org/seurat/articles/spatial_vignette + repository: https://github.com/satijalab/seurat arguments: - name: "--n_pcs" diff --git a/src/methods/stereoscope/config.vsh.yaml b/src/methods/stereoscope/config.vsh.yaml index 2ffaa11..443dab8 100644 --- a/src/methods/stereoscope/config.vsh.yaml +++ b/src/methods/stereoscope/config.vsh.yaml @@ -1,16 +1,17 @@ __merge__: ../../api/comp_method.yaml name: stereoscope - +label: Stereoscope +summary: "Stereoscope is a decomposition method based on Negative Binomial regression." +description: | + Stereoscope is a decomposition method based on Negative Binomial regression. It is similar in scope and implementation to cell2location but less flexible to incorporate additional covariates such as batch effects and other type of experimental design annotations. info: - label: Stereoscope - summary: "Stereoscope is a decomposition method based on Negative Binomial regression." - description: | - Stereoscope is a decomposition method based on Negative Binomial regression. It is similar in scope and implementation to cell2location but less flexible to incorporate additional covariates such as batch effects and other type of experimental design annotations. preferred_normalization: counts - reference: andersson2020single - documentation_url: https://docs.scvi-tools.org/en/stable/user_guide/models/stereoscope.html - repository_url: https://github.com/scverse/scvi-tools +references: + doi: 10.1038/s42003-020-01247-y +links: + documentation: https://docs.scvi-tools.org/en/stable/user_guide/models/stereoscope.html + repository: https://github.com/scverse/scvi-tools arguments: - name: "--max_epochs_sc" diff --git a/src/methods/tangram/config.vsh.yaml b/src/methods/tangram/config.vsh.yaml index 0bb5aeb..cae23fe 100644 --- a/src/methods/tangram/config.vsh.yaml +++ b/src/methods/tangram/config.vsh.yaml @@ -1,15 +1,17 @@ __merge__: ../../api/comp_method.yaml name: tangram +label: Tangram +summary: "Tanagram maps single-cell gene expression data onto spatial gene expression data by fitting gene expression on shared genes" +description: | + Tangram is a method to map gene expression signatures from scRNA-seq data to spatial data. It performs the cell type mapping by learning a similarity matrix between single-cell and spatial locations based on gene expression profiles. info: - label: Tangram - summary: "Tanagram maps single-cell gene expression data onto spatial gene expression data by fitting gene expression on shared genes" - description: | - Tangram is a method to map gene expression signatures from scRNA-seq data to spatial data. It performs the cell type mapping by learning a similarity matrix between single-cell and spatial locations based on gene expression profiles. preferred_normalization: counts - reference: biancalani2021deep - documentation_url: https://tangram-sc.readthedocs.io/en/latest/index.html - repository_url: https://github.com/broadinstitute/Tangram +references: + doi: 10.1038/s41592-021-01264-7 +links: + documentation: https://tangram-sc.readthedocs.io/en/latest/index.html + repository: https://github.com/broadinstitute/Tangram arguments: - name: "--num_epochs" diff --git a/src/methods/vanillanmf/config.vsh.yaml b/src/methods/vanillanmf/config.vsh.yaml index 232e816..de1b943 100644 --- a/src/methods/vanillanmf/config.vsh.yaml +++ b/src/methods/vanillanmf/config.vsh.yaml @@ -1,15 +1,17 @@ __merge__: ../../api/comp_method.yaml name: vanillanmf +label: NMF +summary: "NMF reconstructs gene expression as a weighted combination of cell type signatures defined by scRNA-seq." +description: | + NMF is a decomposition method based on Non-negative Matrix Factorization (NMF) that reconstructs expression of each spatial location as a weighted combination of cell-type signatures defined by scRNA-seq. It is a simpler baseline than NMFreg as it only performs the NMF step based on mean expression signatures of cell types, returning the weights loading of the NMF as (normalized) cell type proportions, without the regression step. info: - label: NMF - summary: "NMF reconstructs gene expression as a weighted combination of cell type signatures defined by scRNA-seq." - description: | - NMF is a decomposition method based on Non-negative Matrix Factorization (NMF) that reconstructs expression of each spatial location as a weighted combination of cell-type signatures defined by scRNA-seq. It is a simpler baseline than NMFreg as it only performs the NMF step based on mean expression signatures of cell types, returning the weights loading of the NMF as (normalized) cell type proportions, without the regression step. preferred_normalization: counts - reference: cichocki2009fast - documentation_url: https://scikit-learn.org/stable/modules/generated/sklearn.decomposition.NMF.html - repository_url: https://github.com/scikit-learn/scikit-learn/blob/92c9b1866/sklearn/decomposition/ +references: + doi: 10.1587/transfun.e92.a.708 +links: + documentation: https://scikit-learn.org/stable/modules/generated/sklearn.decomposition.NMF.html + repository: https://github.com/scikit-learn/scikit-learn/blob/92c9b1866/sklearn/decomposition/ arguments: - name: "--max_iter" diff --git a/src/metrics/jsd/config.vsh.yaml b/src/metrics/jsd/config.vsh.yaml index 62e6bc6..c46d7b5 100644 --- a/src/metrics/jsd/config.vsh.yaml +++ b/src/metrics/jsd/config.vsh.yaml @@ -8,9 +8,11 @@ info: summary: "Jensen-Shannon Distance measure the similarity between to probability distributions." description: | The Jensen-Shannon Distance, which is the square root of Jensen-Shannon Divergence is a symmetric method for measuring the similarity between two probability distributions. The similarity between the distributions is greater when the Jensen-Shannon distance is closer to zero. - reference: 10.1109/18.61115 - documentation_url: https://docs.scipy.org/doc/scipy/reference/generated/scipy.spatial.distance.jensenshannon.html - repository_url: https://github.com/scipy/scipy/ + references: + doi: 10.1109/18.61115 + links: + documentation: https://docs.scipy.org/doc/scipy/reference/generated/scipy.spatial.distance.jensenshannon.html + repository: https://github.com/scipy/scipy/ min: 0 max: 1 maximize: false diff --git a/src/metrics/r2/config.vsh.yaml b/src/metrics/r2/config.vsh.yaml index 30ba527..0f68364 100644 --- a/src/metrics/r2/config.vsh.yaml +++ b/src/metrics/r2/config.vsh.yaml @@ -8,9 +8,11 @@ info: summary: "R2 represents the proportion of variance in the true proportions which is explained by the predicted proportions." description: | R2, or the “coefficient of determination”, reports the fraction of the true proportion values' variance that can be explained by the predicted proportion values. The best score, and upper bound, is 1.0. There is no fixed lower bound for the metric. The uniform/non-weighted average across all cell types/states is used to summarise performance. By default, cases resulting in a score of NaN (perfect predictions) or -Inf (imperfect predictions) are replaced with 1.0 (perfect predictions) or 0.0 (imperfect predictions) respectively. - reference: miles2005rsquared - documentation_url: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.r2_score.html - repository_url: https://github.com/scikit-learn/scikit-learn + references: + doi: 10.1002/0470013192.bsa526 + links: + documentation: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.r2_score.html + repository: https://github.com/scikit-learn/scikit-learn min: -inf max: 1 maximize: true