From 87460e1d4b502046e099f1625515aaa2b97835bc Mon Sep 17 00:00:00 2001 From: LTLA Date: Sat, 7 Sep 2024 21:27:29 -0700 Subject: [PATCH] Various fixes to get rid of all the CHECK warnings. - Updated all the URLs to their new locations. - Avoid errors due to core limits during CHECK. - Renamed the LICENSE to respect CRAN's dislike of license copies. --- .Rbuildignore | 1 + DESCRIPTION | 6 +++--- LICENSE => LICENSE.txt | 0 R/combineRecomputedResults.R | 2 +- README.md | 8 ++++---- inst/NEWS.Rd | 2 +- man/combineRecomputedResults.Rd | 2 +- tests/testthat/test-aggregate.R | 4 ++-- tests/testthat/test-recomputed.R | 2 +- vignettes/SingleR.Rmd | 8 ++++---- 10 files changed, 18 insertions(+), 17 deletions(-) rename LICENSE => LICENSE.txt (100%) diff --git a/.Rbuildignore b/.Rbuildignore index 1ce11479..e3b415ba 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -3,3 +3,4 @@ ^Dockerfile$ ^\.github$ ^\.gitignore$ +^LICENSE\.txt$ diff --git a/DESCRIPTION b/DESCRIPTION index e407c18b..eae6fe4f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -10,7 +10,7 @@ Authors@R: c(person("Dvir", "Aran", email="dvir.aran@ucsf.edu", role=c("aut", "c Description: Performs unbiased cell type recognition from single-cell RNA sequencing data, by leveraging reference transcriptomic datasets of pure cell types to infer the cell of origin of each single cell independently. -License: GPL-3 + file LICENSE +License: GPL-3 Depends: SummarizedExperiment Imports: methods, @@ -60,5 +60,5 @@ SystemRequirements: C++17 VignetteBuilder: knitr Encoding: UTF-8 RoxygenNote: 7.3.2 -URL: https://github.com/LTLA/SingleR -BugReports: https://support.bioconductor.org/ +URL: https://github.com/SingleR-inc/SingleR +BugReports: https://github.com/SingleR-inc/SingleR/issues diff --git a/LICENSE b/LICENSE.txt similarity index 100% rename from LICENSE rename to LICENSE.txt diff --git a/R/combineRecomputedResults.R b/R/combineRecomputedResults.R index b86905d1..512da13a 100644 --- a/R/combineRecomputedResults.R +++ b/R/combineRecomputedResults.R @@ -71,7 +71,7 @@ #' @references #' Lun A, Bunis D, Andrews J (2020). #' Thoughts on a more scalable algorithm for multiple references. -#' \url{https://github.com/LTLA/SingleR/issues/94} +#' \url{https://github.com/SingleR-inc/SingleR/issues/94} #' #' @examples #' # Making up data. diff --git a/README.md b/README.md index 70f94035..2e2f481c 100644 --- a/README.md +++ b/README.md @@ -38,19 +38,19 @@ install.packages("BiocManager") BiocManager::install("SingleR", version = "devel") ``` -Alternatively, you can install it from GitHub using the [devtools](https://github.com/hadley/devtools "devtools") package. +Alternatively, you can install it from GitHub using the [devtools](https://github.com/r-lib/devtools "devtools") package. ```r install.packages("devtools") library(devtools) -install_github("LTLA/SingleR") +install_github("SingleR-inc/SingleR") ``` ## Usage The `SingleR()` function annotates each cell in a test dataset given a reference dataset with known labels. Documentation and basic examples can be accessed with `?SingleR`. -Both basic and advanced examples can be found in the [SingleR book](https://ltla.github.io/SingleRBook/). +Both basic and advanced examples can be found in the [SingleR book](https://bioconductor.org/books/devel/SingleRBook/). ### Usage with Seurat/SingleCellExperiment objects @@ -78,4 +78,4 @@ Using broad labels can reduce the time to under 15 minutes, though run times wil SingleR was originally developed by Dvir Aran. This refactor was initiated by Aaron Lun, with additional contributions from Daniel Bunis, Friederike Dündar, and Jared Andrews. -[Issues](https://github.com/LTLA/SingleR/issues) and [pull requests](https://github.com/LTLA/SingleR/pulls) are welcome. +[Issues](https://github.com/SingleR-inc/SingleR/issues) and [pull requests](https://github.com/SingleR-inc/SingleR/pulls) are welcome. diff --git a/inst/NEWS.Rd b/inst/NEWS.Rd index f24d9ad3..a99e3b95 100644 --- a/inst/NEWS.Rd +++ b/inst/NEWS.Rd @@ -46,7 +46,7 @@ Restrict the PCA to the top 1000 most highly variable genes, for speed. \section{Version 1.4.0}{\itemize{ \item Migrated all of the dataset getter functions to the \pkg{celldex} package. -\item Streamlined the vignette to point to the book at \url{http://bioconductor.org/books/devel/SingleRBook/}. +\item Streamlined the vignette to point to the book at \url{https://bioconductor.org/books/devel/SingleRBook/}. \item Added a \code{restrict=} argument to \code{trainSingleR()} and \code{SingleR()} to easily restrict to a subset of features. diff --git a/man/combineRecomputedResults.Rd b/man/combineRecomputedResults.Rd index c49d232f..6a73c7ba 100644 --- a/man/combineRecomputedResults.Rd +++ b/man/combineRecomputedResults.Rd @@ -134,7 +134,7 @@ combined[,1:5] \references{ Lun A, Bunis D, Andrews J (2020). Thoughts on a more scalable algorithm for multiple references. -\url{https://github.com/LTLA/SingleR/issues/94} +\url{https://github.com/SingleR-inc/SingleR/issues/94} } \seealso{ \code{\link{SingleR}} and \code{\link{classifySingleR}}, for generating predictions to use in \code{results}. diff --git a/tests/testthat/test-aggregate.R b/tests/testthat/test-aggregate.R index bb6894d6..b5267b39 100644 --- a/tests/testthat/test-aggregate.R +++ b/tests/testthat/test-aggregate.R @@ -108,7 +108,7 @@ test_that("aggregateReference seed setter behaves correctly", { setAutoBPPARAM(SerialParam()) set.seed(20) - out <- aggregateReference(sce, labels, BPPARAM=BiocParallel::SnowParam(3)) + out <- aggregateReference(sce, labels, BPPARAM=BiocParallel::SnowParam(2)) expect_identical(ref, out) # The seed is unset properly for downstream applications. @@ -117,7 +117,7 @@ test_that("aggregateReference seed setter behaves correctly", { test1 <- runif(10) set.seed(10) - aggregateReference(sce, labels, BPPARAM=BiocParallel::SnowParam(3)) + aggregateReference(sce, labels, BPPARAM=BiocParallel::SnowParam(2)) test2 <- runif(10) expect_identical(test1, test2) diff --git a/tests/testthat/test-recomputed.R b/tests/testthat/test-recomputed.R index be75d4c5..a91244a1 100644 --- a/tests/testthat/test-recomputed.R +++ b/tests/testthat/test-recomputed.R @@ -62,7 +62,7 @@ test_that("combineRecomputedResults matrix fragmentation works as expected", { results=list(pred1, pred2), test=test, trained=list(train1, train2), - BPPARAM=BiocParallel::MulticoreParam(3)) + BPPARAM=BiocParallel::MulticoreParam(2)) expect_equal(combined1, combined1x) # Testing that it works for DA's, as well as when the DA diff --git a/vignettes/SingleR.Rmd b/vignettes/SingleR.Rmd index eaf1ee86..17f1fe77 100644 --- a/vignettes/SingleR.Rmd +++ b/vignettes/SingleR.Rmd @@ -37,7 +37,7 @@ for the reference dataset, and this biological knowledge can be propagated to ne To keep things brief, this vignette only provides a brief summary of the basic capabilities of `r Biocpkg("SingleR")`. However, the package also provides more advanced functionality that includes the use of multiple references simultaneously, manipulating the cell ontology and improving performance on big datasets. -Readers are referred to the [book](http://bioconductor.org/books/devel/SingleRBook/) for more details. +Readers are referred to the [book](https://bioconductor.org/books/devel/SingleRBook/) for more details. # Using built-in references @@ -171,7 +171,7 @@ plotHeatmap(sceG, order_columns_by="labels", *How can I use this with my `Seurat`, `SingleCellExperiment`, or `cell_data_set` object?* `r Biocpkg("SingleR")` is workflow agnostic - all it needs is normalized counts. -An example showing how to map its results back to common single-cell data objects is available in the [README](https://github.com/LTLA/SingleR/blob/master/README.md). +An example showing how to map its results back to common single-cell data objects is available in the [README](https://github.com/SingleR-inc/SingleR/blob/master/README.md). *Where can I find reference sets appropriate for my data?* @@ -183,9 +183,9 @@ but have been migrated into a separate package for more general use by other Bio *Where can I get more help?* It is likely that your questions is already answered by the function documentation (e.g., `?SingleR`). -Further explanations on the reasoning behind certain functions can be found in the [book](https://ltla.github.io/SingleRBook/). +Further explanations on the reasoning behind certain functions can be found in the [book](https://bioconductor.org/books/devel/SingleRBook/). If this is not sufficient, we recommend posting an issue on the [Bioconductor support site](https://support.bioconductor.org) -or [the GitHub repository](https://github.com/LTLA/SingleR) for this package. +or [the GitHub repository](https://github.com/SingleR-inc/SingleR) for this package. Be sure to include your session information and a minimal reproducible example. # Session information