Add comment explaining option usage

PR feedback #2523 (comment)
single-cell-data · Oct 31, 2024 · 7292e8b · 7292e8b
1 parent 02b9a8f
commit 7292e8b
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/apis/r/R/write_seurat.R b/apis/r/R/write_seurat.R
@@ -724,6 +724,8 @@ write_soma.Seurat <- function(
   platform_config = NULL,
   tiledbsoma_ctx = NULL
 ) {
+  # Allow writing `soma_` prefixed columns to SOMADataFrames
+  # (normally disallowed as a reserved prefix)
   op <- options(tiledbsoma.write_soma.internal = TRUE)
   on.exit(options(op), add = TRUE, after = FALSE)
   check_package("SeuratObject", version = .MINIMUM_SEURAT_VERSION())