% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/help_compatibility_layer.R
\name{compatibility_alias_table}
\alias{compatibility_alias_table}
\title{List retained compatibility aliases and preferred names}
\usage{
compatibility_alias_table(
  scope = c("all", "functions", "arguments", "fields", "columns", "plot_metrics")
)
}
\arguments{
\item{scope}{Which alias surface to return: \code{"all"}, \code{"functions"},
\code{"arguments"}, \code{"fields"}, \code{"columns"}, or \code{"plot_metrics"}.}
}
\value{
A data.frame with one row per retained alias and columns:
\itemize{
\item \code{Alias}
\item \code{PreferredName}
\item \code{Surface}
\item \code{Lifecycle}
\item \code{RetainedFor}
\item \code{RemovalPlan}
\item \code{Notes}
}
}
\description{
List retained compatibility aliases and preferred names
}
\details{
This helper is a compact public registry of the compatibility aliases that
\code{mfrmr} intentionally keeps visible for older scripts and downstream
handoffs. It is meant to answer two questions quickly:
\enumerate{
\item Which old names are still accepted?
\item Which package-native names should new code use instead?
}

Internal soft-deprecated helpers are deliberately excluded here. This table
is only for retained user-facing aliases that remain part of the public
surface.
}
\section{Typical workflow}{

\enumerate{
\item Call \code{compatibility_alias_table()} when reading older scripts or reports.
\item Use \code{PreferredName} when updating older analysis code.
\item Prefer the package-native name in all new outputs and scripts.
}
}

\examples{
compatibility_alias_table()
compatibility_alias_table("functions")
compatibility_alias_table("fields")
compatibility_alias_table("columns")
}
\seealso{
\link{mfrmr_compatibility_layer}, \code{\link[=run_mfrm_facets]{run_mfrm_facets()}}, \code{\link[=analyze_dff]{analyze_dff()}},
\code{\link[=reporting_checklist]{reporting_checklist()}}, \code{\link[=fair_average_table]{fair_average_table()}}, \code{\link[=plot_fair_average]{plot_fair_average()}}
}
