% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/registry.R
\name{geom_args}
\alias{geom_args}
\title{Show Arguments for a Geometry}
\usage{
geom_args(type = NULL)
}
\arguments{
\item{type}{Character.  Geometry name, e.g. \code{"line"}, \code{"ranked_bar"}.
If \code{NULL} (default), prints a summary for every registered geometry.}
}
\value{
A data frame of argument metadata, invisibly.  The primary purpose
is the side-effect of printing.
}
\description{
Prints the required and optional \code{...} arguments accepted by a geometry
when used with \code{\link[=hd_make]{hd_make()}}.  This is the primary discoverability tool
for geometry-specific arguments that do not appear in \code{hd_make()}'s
signature.
}
\section{Why this exists}{

\code{hd_make()} uses \code{...} for all geometry-specific arguments so its own
signature stays clean regardless of how many geometries are registered.
The trade-off is that users cannot see available args from \code{hd_make()}
alone.  \code{geom_args()} solves that: it reads the \code{required_args} and
\code{optional_args} fields registered for each geometry and presents them
in a readable table.
}

\examples{
geom_args("line")
geom_args("ranked_bar")
geom_args("arearange")
geom_args()           # all registered geometries

}
