Browse code

edit for BioC resubmission

Jieun Kim authored on 11/10/2021 22:35:00
Showing 5 changed files

... ...
@@ -1,6 +1,6 @@
1 1
 Package: Cepo
2 2
 Title: Cepo for the identification of differentially stable genes
3
-Version: 0.99.2
3
+Version: 0.99.3
4 4
 Authors@R: 
5 5
     c(
6 6
     person(given = "Hani Jieun",
... ...
@@ -51,4 +51,5 @@ Suggests:
51 51
     patchwork
52 52
 VignetteBuilder: knitr
53 53
 Depends: 
54
+    GSEABase,
54 55
     R (>= 4.1)
... ...
@@ -18,6 +18,14 @@ using the `remotes` package:
18 18
 remotes::install_github("PYangLab/Cepo")
19 19
 ```
20 20
 
21
+You can install the Bioconductor version of _Cepo_ from:
22
+
23
+``` r
24
+if (!requireNamespace("BiocManager", quietly = TRUE))
25
+    install.packages("BiocManager")
26
+BiocManager::install("Cepo")
27
+```
28
+
21 29
 To also build the vignettes use:
22 30
 
23 31
 ``` r
... ...
@@ -21,39 +21,54 @@ Cepo(
21 21
 )
22 22
 }
23 23
 \arguments{
24
-\item{exprsMat}{Expression matrix where columns denote cells and rows denote genes}
24
+\item{exprsMat}{Expression matrix where columns denote cells and rows
25
+denote genes}
25 26
 
26 27
 \item{cellTypes}{Vector of cell type labels}
27 28
 
28
-\item{minCells}{Integer indicating the minimum number of cells required within a cell type}
29
+\item{minCells}{Integer indicating the minimum number of cells required
30
+within a cell type}
29 31
 
30
-\item{minCelltype}{Integer indicating the minimum number of cell types required in each batch}
32
+\item{minCelltype}{Integer indicating the minimum number of cell types
33
+required in each batch}
31 34
 
32
-\item{exprsPct}{Percentage of lowly expressed genes to remove. Default to NULL to not remove any genes.}
35
+\item{exprsPct}{Percentage of lowly expressed genes to remove.
36
+Default to NULL to not remove any genes.}
33 37
 
34
-\item{logfc}{Numeric value indicating the threshold of log fold-change to use to filter genes.}
38
+\item{logfc}{Numeric value indicating the threshold of log fold-change
39
+to use to filter genes.}
35 40
 
36
-\item{computePvalue}{Whether to compute p-values using bootstrap test. Default to NULL to not make computations.
37
-Set this to an integer to set the number of bootstraps needed (recommend to be at least 100).}
41
+\item{computePvalue}{Whether to compute p-values using bootstrap test.
42
+Default to NULL to not make computations.
43
+Set this to an integer to set the number of bootstraps needed
44
+(recommend to be at least 100).}
38 45
 
39
-\item{variability}{A character indicating the stability measure (CV, IQR, MAD, SD). Default is set to CV.}
46
+\item{variability}{A character indicating the stability measure
47
+(CV, IQR, MAD, SD). Default is set to CV.}
40 48
 
41
-\item{method}{Character indicating the method for integration the two stability measures. By default this is set to "weightedMean" with eqaul weights.}
49
+\item{method}{Character indicating the method for integration
50
+the two stability measures. By default this is set to
51
+'weightedMean' with equal weights.}
42 52
 
43
-\item{weight}{Vector of two values indicating the weights for each stability measure. By default this value is c(0.5, 0.5).}
53
+\item{weight}{Vector of two values indicating the weights for each stability
54
+measure. By default this value is c(0.5, 0.5).}
44 55
 
45
-\item{workers}{Number of cores to use. Default to 1, which invokes \code{BiocParallel::SerialParam}.
46
-For workers greater than 1, see the \code{workers} argument in \code{BiocParallel::MulticoreParam} and \code{BiocParallel::SnowParam}.}
56
+\item{workers}{Number of cores to use. Default to 1, which invokes
57
+\code{BiocParallel::SerialParam}.
58
+For workers greater than 1, see the \code{workers} argument in
59
+\code{BiocParallel::MulticoreParam} and \code{BiocParallel::SnowParam}.}
47 60
 
48 61
 \item{block}{Vector of batch labels}
49 62
 
50
-\item{...}{Additional arguments passed to \code{BiocParallel::MulticoreParam} and \code{BiocParallel::SnowParam}.}
63
+\item{...}{Additional arguments passed to \code{BiocParallel::MulticoreParam}
64
+and \code{BiocParallel::SnowParam}.}
51 65
 }
52 66
 \value{
53 67
 Returns a list of key genes.
54 68
 }
55 69
 \description{
56
-ExprsMat accepts various matrix objects, including DelayedArray and HDF5Array for
70
+ExprsMat accepts various matrix objects,
71
+including DelayedArray and HDF5Array for
57 72
 out-of-memory computations. See vignette.
58 73
 }
59 74
 \examples{
... ...
@@ -7,10 +7,13 @@
7 7
 setCepoBPPARAM(workers = 1L, ...)
8 8
 }
9 9
 \arguments{
10
-\item{workers}{Number of cores to use. Default to 1, which invokes \code{BiocParallel::SerialParam}.
11
-For workers greater than 1, see the \code{workers} argument in \code{BiocParallel::MulticoreParam} and \code{BiocParallel::SnowParam}.}
10
+\item{workers}{Number of cores to use. Default to 1, which invokes
11
+\code{BiocParallel::SerialParam}.
12
+For workers greater than 1, see the \code{workers} argument in
13
+\code{BiocParallel::MulticoreParam} and \code{BiocParallel::SnowParam}.}
12 14
 
13
-\item{...}{Additional arguments passed to \code{BiocParallel::MulticoreParam} and \code{BiocParallel::SnowParam}.}
15
+\item{...}{Additional arguments passed to \code{BiocParallel::MulticoreParam}
16
+and \code{BiocParallel::SnowParam}.}
14 17
 }
15 18
 \value{
16 19
 Parameters for parallel computing depending on OS
... ...
@@ -33,8 +33,9 @@ citation("Cepo")
33 33
 ## Package installation
34 34
 The development version of *Cepo* can be installed with the following command:
35 35
 ```
36
-install.packages("remotes")
37
-remotes::install_github("PYangLab/Cepo")
36
+if (!requireNamespace("BiocManager", quietly = TRUE))
37
+    install.packages("BiocManager")
38
+BiocManager::install("Cepo")
38 39
 ```
39 40
 
40 41
 # Differential stability analysis using Cepo
... ...
@@ -255,8 +256,7 @@ library(escape)
255 256
 library(fgsea)
256 257
 hallmark <- getGeneSets(species = "Homo sapiens", 
257 258
                            library = "H")
258
-hallmarkList <- lapply([email protected], function(x) x@geneIds)
259
-names(hallmarkList) <- lapply([email protected], function(x) x@setName)
259
+hallmarkList <- geneIds(hallmark)
260 260
 
261 261
 fgseaRes <- fgsea(pathways = hallmarkList, 
262 262
                   stats    = sort(ds_res_batches$average$stats[,"beta"]),