diff --git a/DESCRIPTION b/DESCRIPTION index 0c772d7..26e908a 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,5 +1,5 @@ Package: scregclust -Title: Reconstructing the regulatory programs of target genes in single cell data +Title: Reconstructing the Regulatory Programs of Target Genes in scRNA-seq data Version: 0.1.10 Authors@R: c( person("Felix", "Held", ,"felix.held@gmail.com", role = c("aut", "cre"), @@ -8,8 +8,8 @@ Authors@R: c( comment = c(ORCID = "0000-0001-5422-4243")), person("Sven", "Nelander", ,"sven.nelander@igp.uu.se", role = c("aut"), comment = c(ORCID = "0000-0003-1758-1262"))) -Description: This package provides an implementation of the scregclust - algorithm (Larsson, Held, et al., 2024, ) +Description: Implementation of the scregclust algorithm + (Larsson, Held, et al., 2024, ) which aims to reconstruct the regulatory programs of target genes in single cell data. Target genes are clustered into modules and each module is associated with a linear model accounting for the regulatory program driving the genes it contains. diff --git a/R/plotting.R b/R/plotting.R index e1c9bec..0746ff6 100644 --- a/R/plotting.R +++ b/R/plotting.R @@ -261,7 +261,7 @@ collect_silhouette_data <- function(list_of_fits) { #' Either a single number to be used for all fits in #' `list_of_fits`, or one for each individual fit. #' -#' @return A [`ggplot2`] plot showing the the silhouette scores for each +#' @return A ggplot2 plot showing the the silhouette scores for each #' supplied fit. #' #' @concept plotting @@ -439,7 +439,7 @@ plot_silhouettes <- function(list_of_fits, penalization, final_config = 1L) { #' for the same penalty parameter across all fits in #' `list_of_fits`, or one for each individual fit. #' -#' @return A [ggplot2] plot showing the average silhouette score and the +#' @return A ggplot2 plot showing the average silhouette score and the #' average predictive \eqn{R^2} #' #' @concept plotting diff --git a/README.md b/README.md index bf13ed1..d100139 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ The goal of *scregclust* is to cluster genes by regulatory programs. To do so, genes are clustered into modules which in turn are associated with regulators. The algorithm alternates between associating regulators to modules and reallocating target genes into modules. -- The documentation for this package can be found at [https://scmethods.github.io/scregclust](https://scmethods.github.io/scregclust) +- The documentation for this package can be found at [https://scmethods.github.io/scregclust/](https://scmethods.github.io/scregclust/) - A detailed description of the algorithm and an in-depth evaluation of its properties can be found in our original research article [Larsson, Held, et al. (2024) Reconstructing the regulatory programs underlying the phenotypic plasticity of neural cancers. Nature Communications 15, 9699 DOI 10.1038/s41467-024-53954-3](https://doi.org/10.1038/s41467-024-53954-3) ## Installation diff --git a/man/plot_module_count_helper.Rd b/man/plot_module_count_helper.Rd index da6e137..61204d8 100644 --- a/man/plot_module_count_helper.Rd +++ b/man/plot_module_count_helper.Rd @@ -16,7 +16,7 @@ for the same penalty parameter across all fits in \code{list_of_fits}, or one for each individual fit.} } \value{ -A \link{ggplot2} plot showing the average silhouette score and the +A ggplot2 plot showing the average silhouette score and the average predictive \eqn{R^2} } \description{ diff --git a/man/plot_silhouettes.Rd b/man/plot_silhouettes.Rd index 5235484..6ed6f4b 100644 --- a/man/plot_silhouettes.Rd +++ b/man/plot_silhouettes.Rd @@ -20,7 +20,7 @@ Either a single number to be used for all fits in \code{list_of_fits}, or one for each individual fit.} } \value{ -A \code{\link{ggplot2}} plot showing the the silhouette scores for each +A ggplot2 plot showing the the silhouette scores for each supplied fit. } \description{ diff --git a/man/scregclust-package.Rd b/man/scregclust-package.Rd index 164adc3..8f35a2f 100644 --- a/man/scregclust-package.Rd +++ b/man/scregclust-package.Rd @@ -3,9 +3,9 @@ \docType{package} \name{scregclust-package} \alias{scregclust-package} -\title{scregclust: Reconstructing the regulatory programs of target genes in single cell data} +\title{scregclust: Reconstructing the Regulatory Programs of Target Genes in scRNA-seq data} \description{ -This package provides an implementation of our scRegClust algorithm (Larsson, Held, et al., 2023, \doi{10.1101/2023.03.10.532041}) which aims to reconstruct the regulatory programs of target genes in single cell data. Target genes are clustered into modules and each module is associated with a linear model accounting for the regulatory program driving the genes it contains. +Implementation of the scregclust algorithm (Larsson, Held, et al., 2024, \doi{10.1038/s41467-024-53954-3}) which aims to reconstruct the regulatory programs of target genes in single cell data. Target genes are clustered into modules and each module is associated with a linear model accounting for the regulatory program driving the genes it contains. } \details{ Computational methods for the scregclust algorithm diff --git a/vignettes/pbmc.Rmd b/vignettes/pbmc.Rmd index 0604978..8f0da2f 100644 --- a/vignettes/pbmc.Rmd +++ b/vignettes/pbmc.Rmd @@ -138,7 +138,7 @@ for convenience. # saveRDS(fit, file = "pbmc_scregclust.rds") url <- paste0( - "https://github.com/sven-nelander/scregclust/raw/main/datasets/", + "https://github.com/scmethods/scregclust/raw/main/datasets/", "pbmc_scregclust.rds" ) path <- "pbmc_scregclust.rds"