[feat] Add the option to create the light version of the ClustAssess shiny app.

Author: AndiMunteanu

R/generics.R

@@ -2,10 +2,18 @@
 #'
 #' @description Creates the ClustAssess ShinyApp based on the output of the
 #' automatic ClustAssess pipeline. In addition to that, the expression matrix
-#' and the metadata dataframe are provided as input to the ShinyApp.
+#' and the metadata dataframe are provided as input to the ShinyApp. If the
+#' clustassess object is not provided, the function will create the light
+#' version of the ClustAssess ShinyApp, that will not contain the
+#' assessment results. For this case, the `metadata` parameter should contain
+#' two aditional columns named 'UMAP_1" and 'UMAP_2' that will correspond to
+#' the 2D embedding of the cells.
 
 #' @param object A Seurat object or an expression matrix
-#' @param clustassess_object The output of the ClustAssess automatic pipeline
+#' @param clustassess_object The output of the ClustAssess automatic pipeline.
+#' If the ClustAssess object is not provided (NULL), the function will create
+#' the light version of the ShinyApp, that will not contain the assessment
+#' results.
 #' @param project_folder The folder where the files will be written
 #' @param metadata The metadata dataframe. This parameter will be ignored if
 #' the object is a Seurat object.