% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/m2dt_utils.R
\name{format_analysis_counts}
\alias{format_analysis_counts}
\title{Describe the analyzed sample for console output}
\usage{
format_analysis_counts(counts, label = "Observations analyzed", marks = NULL)
}
\arguments{
\item{counts}{List as returned by \code{get_analysis_counts()}.}

\item{label}{Character label preceding the counts.}

\item{marks}{List of number marks as returned by
\code{resolve_number_marks()}. Counts and percentages are separated as
the accompanying table separates them, so that a locale setting applies
to the whole of the output rather than to the table alone. Resolved from
the global option when not supplied.}
}
\value{
Character string, or \code{NULL} when the counts are unavailable.
}
\description{
Renders the counts produced by \code{get_analysis_counts()} as a single line
for the \code{print()} methods. The line is produced whenever the counts are
available, including when every supplied observation entered the analysis:
a complete sample is itself worth stating, and reporting it only on loss
would leave the reader to infer the difference between no exclusions and no
disclosure.
}
\keyword{internal}
