% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/memory.R
\name{format_memory_warning}
\alias{format_memory_warning}
\title{Format a human-readable memory warning message}
\usage{
format_memory_warning(memory_estimate)
}
\arguments{
\item{memory_estimate}{A `gwpr_memory_estimate` list, typically the
return value of \code{\link{estimate_memory}}.}
}
\value{
A character string containing the warning text.  The string is
  suitable for passing to \code{message()} or \code{warning()}.
}
\description{
Converts a `gwpr_memory_estimate` object (produced by
\code{\link{estimate_memory}}) into a readable character string.  For
high-risk estimates the message also includes actionable suggestions.
}
\keyword{internal}
