CA: mark multi-VC comparison columns as experimental
The comparison column layout is still settling. Badge the section
experimental and say plainly that names and semantics may change without a
deprecation cycle, so that shipping it does not lock the current column
names in place.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Change-Id: I75c0042607cc9ae61ce9b1a904982509276e00eb
diff --git a/R/collocationAnalysis.R b/R/collocationAnalysis.R
index b949e2c..4f827eb 100644
--- a/R/collocationAnalysis.R
+++ b/R/collocationAnalysis.R
@@ -65,8 +65,15 @@
#' }
#' @section Interpreting multi-VC comparisons:
#'
-#' The comparison columns are an exploration aid, not a significance test. When
-#' reading them, keep three properties in mind.
+#' `r lifecycle::badge("experimental")`
+#'
+#' The comparison columns produced when `vc` holds more than one virtual corpus
+#' are experimental: their names and semantics may still change in a future
+#' release without a deprecation cycle. Code that has to keep working across
+#' versions should select the columns it needs explicitly.
+#'
+#' They are an exploration aid, not a significance test. When reading them, keep
+#' three properties in mind.
#'
#' \strong{Imputed scores describe presence/absence, not contrast.} A collocate
#' that passes the `minOccur` and `topCollocatesLimit` thresholds in one virtual
diff --git a/man/collocationAnalysis-KorAPConnection-method.Rd b/man/collocationAnalysis-KorAPConnection-method.Rd
index 0abff24..02c3f03 100644
--- a/man/collocationAnalysis-KorAPConnection-method.Rd
+++ b/man/collocationAnalysis-KorAPConnection-method.Rd
@@ -125,8 +125,15 @@
\section{Interpreting multi-VC comparisons}{
-The comparison columns are an exploration aid, not a significance test. When
-reading them, keep three properties in mind.
+\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}
+
+The comparison columns produced when \code{vc} holds more than one virtual corpus
+are experimental: their names and semantics may still change in a future
+release without a deprecation cycle. Code that has to keep working across
+versions should select the columns it needs explicitly.
+
+They are an exploration aid, not a significance test. When reading them, keep
+three properties in mind.
\strong{Imputed scores describe presence/absence, not contrast.} A collocate
that passes the \code{minOccur} and \code{topCollocatesLimit} thresholds in one virtual