Browse code

Adding package-level documentation file

Nick authored on 30/09/2022 00:12:19
Showing 1 changed files

1 1
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