From ab83eb950364e145c3dff346b116d5ac7efd7456 Mon Sep 17 00:00:00 2001 From: PratibhaPanwar <7644123+PratibhaPanwar@users.noreply.github.com> Date: Thu, 19 Sep 2024 09:38:57 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20SydneyBi?= =?UTF-8?q?oX/clustSIGNAL@3de0c608e0f1cc510404326705fc5a02356f5fb9=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 12 +- articles/clustSIGNAL.html | 707 ++++++++++++++++++ .../figure-html/unnamed-chunk-12-1.png | Bin 0 -> 215569 bytes .../figure-html/unnamed-chunk-20-1.png | Bin 0 -> 193903 bytes .../figure-html/unnamed-chunk-21-1.png | Bin 0 -> 194577 bytes .../figure-html/unnamed-chunk-9-1.png | Bin 0 -> 186857 bytes articles/index.html | 16 +- authors.html | 18 +- index.html | 38 +- pkgdown.js | 8 + pkgdown.yml | 7 +- reference/adaptiveSmoothing.html | 58 +- reference/clustSIGNAL.html | 93 ++- reference/dot-calculateProp.html | 22 +- reference/dot-cellName.html | 18 +- reference/dot-cellNameSort.html | 28 +- reference/dot-clustNum.html | 21 +- reference/dot-exp_kernel.html | 19 +- reference/dot-gauss_kernel.html | 19 +- reference/dot-generateBPParam.html | 12 +- reference/dot-smoothedData.html | 25 +- reference/entropyMeasure.html | 40 +- reference/example.html | 48 +- reference/index.html | 12 +- reference/mEmbryo2.html | 35 +- reference/mHypothal.html | 49 +- reference/neighbourDetect.html | 52 +- reference/nsClustering.html | 61 +- search.json | 2 +- sitemap.xml | 3 +- 30 files changed, 1102 insertions(+), 321 deletions(-) create mode 100644 articles/clustSIGNAL.html create mode 100644 articles/clustSIGNAL_files/figure-html/unnamed-chunk-12-1.png create mode 100644 articles/clustSIGNAL_files/figure-html/unnamed-chunk-20-1.png create mode 100644 articles/clustSIGNAL_files/figure-html/unnamed-chunk-21-1.png create mode 100644 articles/clustSIGNAL_files/figure-html/unnamed-chunk-9-1.png diff --git a/404.html b/404.html index 2f03d56..2ab2e21 100644 --- a/404.html +++ b/404.html @@ -20,7 +20,7 @@ clustSIGNAL - 0.1.0 + 0.99.0 - - @@ -161,7 +155,7 @@

Developers

diff --git a/pkgdown.js b/pkgdown.js index 9757bf9..1a99c65 100644 --- a/pkgdown.js +++ b/pkgdown.js @@ -152,3 +152,11 @@ async function searchFuse(query, callback) { }); }); })(window.jQuery || window.$) + +document.addEventListener('keydown', function(event) { + // Check if the pressed key is '/' + if (event.key === '/') { + event.preventDefault(); // Prevent any default action associated with the '/' key + document.getElementById('search-input').focus(); // Set focus to the search input + } +}); diff --git a/pkgdown.yml b/pkgdown.yml index 6661783..1d4eefa 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -1,10 +1,9 @@ pandoc: 3.1.11 -pkgdown: 2.1.0 +pkgdown: 2.1.1 pkgdown_sha: ~ articles: - v1_seqFISH_mouseEmbryo: v1_seqFISH_mouseEmbryo.html - v2_MERFISH_mouseHypothalamus: v2_MERFISH_mouseHypothalamus.html -last_built: 2024-09-09T11:43Z + clustSIGNAL: clustSIGNAL.html +last_built: 2024-09-19T09:15Z urls: reference: https://sydneybiox.github.io/clustSIGNAL/reference article: https://sydneybiox.github.io/clustSIGNAL/articles diff --git a/reference/adaptiveSmoothing.html b/reference/adaptiveSmoothing.html index a935898..6f26165 100644 --- a/reference/adaptiveSmoothing.html +++ b/reference/adaptiveSmoothing.html @@ -1,5 +1,13 @@ -Adaptive smoothing — adaptiveSmoothing • clustSIGNAL +Adaptive smoothing — adaptiveSmoothing • clustSIGNAL Skip to contents @@ -7,7 +15,7 @@ clustSIGNAL - 0.1.0 + 0.99.0
-

A function to perform a weighted, adaptive smoothing of gene expression based on the heterogeneity of the cell neighbourhood. Heterogeneous neighbourhoods are smoothed less with higher weights given to cells belonging to same initial group. Homogeneous neighbourhoods are smoothed more with similar weights given to most cells.

+

A function to perform a weighted, adaptive smoothing of gene expression based +on the heterogeneity of the cell neighbourhood. Heterogeneous neighbourhoods +are smoothed less with higher weights given to cells belonging to same initial +group. Homogeneous neighbourhoods are smoothed more with similar weights given +to most cells.

@@ -58,28 +66,44 @@

Argumentsspe -

SpatialExperiment object with logcounts, PCA, 'putative cell type' groups, and entropy outputs included.

+

SpatialExperiment object with logcounts, PCA, 'putative cell type' +groups, and entropy outputs included.

nnCells
-

a character matrix of NN nearest neighbours - rows are cells and columns are their nearest neighbours ranged from closest to farthest neighbour. For sort = TRUE, the neighbours belonging to the same 'putative cell type' group as the cell are moved closer to it.

+

a character matrix of NN nearest neighbours - rows are cells +and columns are their nearest neighbours ranged from closest to farthest +neighbour. For sort = TRUE, the neighbours belonging to the same 'putative +cell type' group as the cell are moved closer to it.

NN
-

an integer for the number of neighbourhood cells the function should consider. The value must be greater than or equal to 1. Default value is 30.

+

an integer for the number of neighbourhood cells the function should +consider. The value must be greater than or equal to 1. Default value is 30.

kernel
-

a character for type of distribution to be used. The two valid values are "G" or "E". G for Gaussian distribution, and E for exponential distribution. Default value is "G".

+

a character for type of distribution to be used. The two valid +values are "G" or "E". G for Gaussian distribution, and E for exponential +distribution. Default value is "G".

spread
-

a numeric value for distribution spread, represented by standard deviation for Gaussian distribution and rate for exponential distribution. Default value is 0.05 for Gaussian distribution and 20 for exponential distribution.

+

a numeric value for distribution spread, represented by standard +deviation for Gaussian distribution and rate for exponential distribution. +Default value is 0.05 for Gaussian distribution and 20 for exponential +distribution.

+ + +
threads
+

a numeric value for the number of CPU cores to be used for the +analysis. Default value set to 1.

Value

-

SpatialExperiment object including smoothed gene expression values as another assay.

+

SpatialExperiment object including smoothed gene expression values as +another assay.

diff --git a/reference/clustSIGNAL.html b/reference/clustSIGNAL.html index d83b612..ae04781 100644 --- a/reference/clustSIGNAL.html +++ b/reference/clustSIGNAL.html @@ -1,5 +1,9 @@ -clustSIGNAL — clustSIGNAL • clustSIGNAL +clustSIGNAL — clustSIGNAL • clustSIGNAL Skip to contents @@ -7,7 +11,7 @@ clustSIGNAL - 0.1.0 + 0.99.0
-

A clustering method for cell type classification of spatial transcriptomics data. The tool generates and uses an adaptively smoothed, spatially informed gene expression data for clustering.

+

A clustering method for cell type classification of spatial transcriptomics +data. The tool generates and uses an adaptively smoothed, spatially informed +gene expression data for clustering.

@@ -48,6 +50,7 @@

Usage samples, cells, dimRed = "None", + batch = FALSE, NN = 30, kernel = "G", spread = 0.05, @@ -67,51 +70,78 @@

Argumentssamples -

a character indicating name of colData(spe) column containing sample names.

+

a character indicating name of colData(spe) column containing +sample names.

cells
-

a character indicating name of colData(spe) column containing cell IDs.

+

a character indicating name of colData(spe) column containing +cell IDs.

dimRed
-

a character indicating the name of the reduced dimensions to use from the SpatialExperiment object (i.e., from reducedDimNames(spe)). Default value is 'PCA'.

+

a character indicating the name of the reduced dimensions to +use from the SpatialExperiment object (i.e., from reducedDimNames(spe)). +Default value is 'None'.

+ + +
batch
+

a logical parameter for whether or not to perform batch +correction. Default value is FALSE.

NN
-

an integer for the number of neighbourhood cells the function should consider. The value must be greater than or equal to 1. Default value is 30.

+

an integer for the number of neighbourhood cells the function +should consider. The value must be greater than or equal to 1. Default value +is 30.

kernel
-

a character for type of distribution to be used. The two valid values are "G" or "E". G for Gaussian distribution, and E for exponential distribution. Default value is "G".

+

a character for type of distribution to be used. The two valid +values are "G" or "E". G for Gaussian distribution, and E for exponential +distribution. Default value is "G".

spread
-

a numeric value for distribution spread, represented by standard deviation for Gaussian distribution and rate for exponential distribution. Default value is 0.05 for Gaussian distribution and 20 for exponential distribution.

+

a numeric value for distribution spread, represented by standard +deviation for Gaussian distribution and rate for exponential distribution. +Default value is 0.05 for Gaussian distribution and 20 for exponential +distribution.

sort
-

a logical parameter for whether or not to sort the neighbourhood after region description. Default value is TRUE.

+

a logical parameter for whether or not to sort the neighbourhood +after region description. Default value is TRUE.

threads
-

a numeric value for the number of CPU cores to be used for the analysis. Default value set to 4 cores.

+

a numeric value for the number of CPU cores to be used for the +analysis. Default value set to 1.

outputs
-

a character for the type of output to return to the user. "c" for data frame of cell IDs and their respective cluster numbers (default), "n" for list of dataframe of clusters plus neighbourhood matrix, "s" for list of dataframe of clusters plus final spatialExperiment object, or "a" for list of all outputs.

+

a character for the type of output to return to the user. "c" +for data frame of cell IDs and their respective cluster numbers (default), "n" +for list of dataframe of clusters plus neighbourhood matrix, "s" for list of +dataframe of clusters plus final spatialExperiment object, or "a" for list of +all outputs.

...
-

additional parameters for TwoStepParam clustering methods. Include parameters like k for number of nearest neighbours and cluster.fun for selecting community detection method. Default values k = 5, cluster.fun = "louvain".

+

additional parameters for TwoStepParam clustering methods. Include +parameters like k for number of nearest neighbours and cluster.fun for +selecting community detection method.

Value

a list of outputs

1. clusters: a data frame of cell names and their cluster classification.

-

2. neighbours: a matrix of cell names and the names of their NN nearest neighbour cells.

-

3. spe_final: a SpatialExperiment object with initial 'putative cell type' groups, entropy values, smoothed gene expression, post-smoothing clusters, and silhouette widths included.

+

2. neighbours: a matrix of cell names and the names of their NN nearest +neighbour cells.

+

3. spe_final: a SpatialExperiment object with initial 'putative cell type' +groups, entropy values, smoothed gene expression, post-smoothing clusters, +and silhouette widths included.

@@ -127,17 +157,18 @@

Examplessamples = "sample_id" cells = "uniqueID" res_list <- clustSIGNAL(spe, samples, cells, outputs = "c") -#> [1] "Calculating PCA to use as reduced dimension input." -#> [1] "clustSIGNAL run started. 2024-09-09 11:44:14.296386" -#> [1] "Initial nonspatial clustering performed. Clusters = 7 2024-09-09 11:44:14.417658" +#> [1] "Calculating PCA. Time 09:15:54" +#> [1] "clustSIGNAL run started. Time 09:15:54" +#> [1] "Initial nonspatial clustering performed. Clusters = 7 Time 09:15:54" #> Warning: You're computing too large a percentage of total singular values, use a standard svd instead. #> Warning: You're computing too large a percentage of total singular values, use a standard svd instead. -#> [1] "Nonspatial subclustering performed. Subclusters = 18 2024-09-09 11:44:15.489613" -#> [1] "Regions defined. 2024-09-09 11:44:15.93757" -#> [1] "Region domainness calculated. 2024-09-09 11:44:16.01349" -#> [1] "Smoothing performed. NN = 30 Kernel = G Spread = 0.05 2024-09-09 11:44:35.34314" -#> [1] "Nonspatial clustering performed on smoothed data. Clusters = 9 2024-09-09 11:44:35.614552" -#> [1] "clustSIGNAL run completed. 2024-09-09 11:44:35.616399" +#> [1] "Nonspatial subclustering performed. Subclusters = 18 Time 09:15:55" +#> [1] "Regions defined. Time 09:15:55" +#> [1] "Region domainness calculated. Time 09:15:56" +#> [1] "Smoothing performed. NN = 30 Kernel = G Spread = 0.05 Time 09:16:16" +#> [1] "Nonspatial clustering performed on smoothed data. Clusters = 9 Time 09:16:16" +#> [1] "clustSIGNAL run completed. 09:16:16" +#> Time difference of 22.60191 secs

@@ -151,7 +182,7 @@

Examples -

Site built with pkgdown 2.1.0.

+

Site built with pkgdown 2.1.1.

diff --git a/reference/dot-calculateProp.html b/reference/dot-calculateProp.html index 22f6966..2de84e9 100644 --- a/reference/dot-calculateProp.html +++ b/reference/dot-calculateProp.html @@ -1,5 +1,7 @@ -Cell neighbourhood composition — .calculateProp • clustSIGNAL +Cell neighbourhood composition — .calculateProp • clustSIGNAL Skip to contents @@ -7,7 +9,7 @@ clustSIGNAL - 0.1.0 + 0.99.0
-

A function to calculate the cell neighbourhood composition of 'putative' cell types.

+

A function to calculate the cell neighbourhood composition of 'putative' cell +types.

@@ -51,7 +50,8 @@

Argumentsarr -

a vector of 'putative cell type' assignments of each cell in the neighbourhood.

+

a vector of 'putative cell type' assignments of each cell in the +neighbourhood.

@@ -68,7 +68,7 @@

Value

diff --git a/reference/dot-cellName.html b/reference/dot-cellName.html index 48b20d8..40f5b27 100644 --- a/reference/dot-cellName.html +++ b/reference/dot-cellName.html @@ -7,7 +7,7 @@ clustSIGNAL - 0.1.0 + 0.99.0
@@ -72,7 +70,7 @@

Value

diff --git a/reference/dot-cellNameSort.html b/reference/dot-cellNameSort.html index 5a8a184..8846474 100644 --- a/reference/dot-cellNameSort.html +++ b/reference/dot-cellNameSort.html @@ -1,5 +1,9 @@ -Neighbour cell sorting — .cellNameSort • clustSIGNAL +Neighbour cell sorting — .cellNameSort • clustSIGNAL Skip to contents @@ -7,7 +11,7 @@ clustSIGNAL - 0.1.0 + 0.99.0
-

A function to perform neighbourhood cell sorting. Neighbourhood cells that belong to the same 'putative cell type' as the central cell are moved closer to the central cell.

+

A function to perform neighbourhood cell sorting. Neighbourhood cells that +belong to the same 'putative cell type' as the central cell are moved closer +to the central cell.

@@ -51,11 +53,13 @@

Argumentscell -

a vector of neighbourhood cell indices. The cell indices indicate the row number of cells in sample metadata.

+

a vector of neighbourhood cell indices. The cell indices indicate +the row number of cells in sample metadata.

Clust
-

a data frame of initial cluster assignments of all cells in the sample.

+

a data frame of initial cluster assignments of all cells in the +sample.

@@ -72,7 +76,7 @@

Value

diff --git a/reference/dot-clustNum.html b/reference/dot-clustNum.html index ffc2ece..cd50fdf 100644 --- a/reference/dot-clustNum.html +++ b/reference/dot-clustNum.html @@ -7,7 +7,7 @@ clustSIGNAL - 0.1.0 + 0.99.0

Value

-

a data frame of 'putative cell type' assignments of neighbourhood cells.

+

a data frame of 'putative cell type' assignments of neighbourhood +cells.