% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/m2dt_utils.R
\name{get_event_variable_for_counts}
\alias{get_event_variable_for_counts}
\title{Identify the event indicator among a model's response variables}
\usage{
get_event_variable_for_counts(outcome_vars, model_type = NULL, family = NULL)
}
\arguments{
\item{outcome_vars}{Character vector of response variable names.}

\item{model_type}{Character string of the model type or class.}

\item{family}{Model family, where applicable. Accepted as a name, a family
object, or a generator function, since callers resolve the family at
different points: \code{fit()} passes the name it was given, while
\code{uniscreen()} may already have resolved \code{"Gamma"} to
\code{Gamma(link = "log")}.}
}
\value{
Character name of the event indicator, or \code{NULL} when the model
  carries no event count.
}
\description{
Determines which response variable carries the event count, and whether the
model has one at all. Linear and Gaussian models do not; the families that
count events are those for which \code{m2dt()} reports an events figure, so
that a denominator is only offered where a numerator exists.
}
\keyword{internal}
