Browse code

Merge pull request #3 from nick-robo/main

Address warnings and in build.

Nick R authored on 30/09/2022 00:29:52 • GitHub committed on 30/09/2022 00:29:52
Showing 8 changed files

... ...
@@ -8,6 +8,4 @@ inst/doc
8 8
 # R CMD build/check outputs
9 9
 *.Rcheck
10 10
 FuseSOM*.tar.gz
11
-
12
-# debugging code
13
-debug.R 
14 11
\ No newline at end of file
12
+*.BiocCheck
... ...
@@ -1,6 +1,6 @@
1 1
 Package: FuseSOM
2 2
 Title: A Correlation Based Multiview Self Organizing Maps Clustering For IMC Datasets
3
-Version: 0.99.1
3
+Version: 0.99.2
4 4
 Authors@R: 
5 5
     person("Elijah", "Willie", , "[email protected]", role = c("aut", "cre"))
6 6
 Description: A correlation based multiview self organizing map for the characterization of cell types (`FuseSOM`) 
... ...
@@ -36,4 +36,4 @@ VignetteBuilder: knitr
36 36
 BugReports: https://github.com/ecool50/FuseSOM/issues
37 37
 LinkingTo: Rcpp
38 38
 biocViews: 
39
-    SingleCell, CellBasedAssays, SingleCellExperiment
39
+    SingleCell, CellBasedAssays
... ...
@@ -18,4 +18,4 @@ importFrom(ggplotify,as.ggplot)
18 18
 importFrom(pheatmap,pheatmap)
19 19
 importFrom(proxy,dist)
20 20
 importFrom(psych,cor2dist)
21
-useDynLib(FuseSOM)
22 21
\ No newline at end of file
22
+useDynLib(FuseSOM)
... ...
@@ -92,7 +92,7 @@ normaliseData <- function(data, markers, method='none', cofactor=5){
92 92
 #' @examples
93 93
 #' data("risom_dat")
94 94
 #' risomMarkers <- c('CD45','SMA','CK7','CK5','VIM','CD31','PanKRT','ECAD')
95
-#' normalizeData(risom_dat[, risomMarkers])
95
+#' normaliseData(risom_dat[, risomMarkers])
96 96
 #' 
97 97
 #' @author
98 98
 #'   Elijah WIllie <[email protected]>
99 99
new file mode 100644
... ...
@@ -0,0 +1,15 @@
1
+#' FuseSOM: FuseSOM provides a pipeline for the clustering of highly
2
+#' multiplexed in situ imaging cytometry assays. This pipeline uses
3
+#' the Self Organizing Map architecture coupled with Multiview hierarchical
4
+#' clustering. We also provide functions for normalisation and estimation
5
+#' of the number of clusters.
6
+#'
7
+#' The FuseSOM package provides three categories of important functions:
8
+#' foo, bar and baz.
9
+#'
10
+#'
11
+#' @docType package
12
+#' @name FuseSOM
13
+#' @useDynLib FuseSOM
14
+NULL
15
+#> NULL
0 16
\ No newline at end of file
... ...
@@ -32,7 +32,6 @@
32 32
   # ------ SILHOUETTE
33 33
   
34 34
   Sil <- NULL
35
-  browser()
36 35
   if('sil' %in% measures) if(k > 1) Sil <- mean(cluster::silhouette(cl, stats::as.dist(dMat))) else Sil <- 0
37 36
 
38 37
   # TODO: Touch base with Elijah to ensure I haven't proken anything 
39 38
new file mode 100644
... ...
@@ -0,0 +1,14 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/FuseSOM.R
3
+\docType{package}
4
+\name{FuseSOM}
5
+\alias{FuseSOM}
6
+\title{FuseSOM: FuseSOM provides a pipeline for the clustering of highly
7
+multiplexed in situ imaging cytometry assays. This pipeline uses
8
+the Self Organizing Map architecture coupled with Multiview hierarchical
9
+clustering. We also provide functions for normalisation and estimation
10
+of the number of clusters.}
11
+\description{
12
+The FuseSOM package provides three categories of important functions:
13
+foo, bar and baz.
14
+}
... ...
@@ -28,7 +28,7 @@ These methods include Percentile, zscore, arsinh and minmax
28 28
 \examples{
29 29
 data("risom_dat")
30 30
 risomMarkers <- c('CD45','SMA','CK7','CK5','VIM','CD31','PanKRT','ECAD')
31
-normalizeData(risom_dat[, risomMarkers])
31
+normaliseData(risom_dat[, risomMarkers])
32 32
 
33 33
 }
34 34
 \author{