blob: 20f55cf17342986f2941731620dd1fdb0509c7da [file] [log] [blame]
Bill Evansb62414a2020-09-14 12:33:38 -07001% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/graphics_helpers.R
3\name{listify_args}
4\alias{listify_args}
5\title{Convert arguments for a single call into Map-able args}
6\usage{
7listify_args(
8 ...,
9 lengths = NA,
10 passthru = c("x", "y"),
11 notlen1vec = c("lim", "xlim", "ylim"),
12 notlen1lst = c("minmax", "min", "max"),
13 ignore = c("same_lim")
14)
15}
16\arguments{
17\item{...}{Arbitrary arguments to be possibly converted into lists
18of arguments.}
19
20\item{lengths}{Allowable lengths of the arguments, typically 1 and
21the length of the main variable (e.g., "x"). If 'NA' (default),
22it is not enforced.}
23
24\item{passthru}{Character vector of variables to pass through with
25no conversion to lists of values. Extra names (not provided in
26\code{...}) are ignored.}
27
28\item{notlen1vec}{Character vector of variables that are known to
29be length over 1 for a single plot call, so it will always be
30list-ified and extra care to ensure it is grouped correctly.
31Extra names (not provided in \code{...}) are ignored.}
32
33\item{notlen1lst}{Character vector of variables that are lists, so
34the inner list length is not checked/enforced. (For example, if a
35single plot call takes an argument \code{list(a=1,b=2,d=3)} and the
36multi-data call creates three plots, then a naive match might
37think that the first plot would get \code{list(a=1)}, second plot gets
38\code{list(b=2)}, etc. Adding that list-argument to this 'notlen1lst'
39will ensure that the full list is passed correctly.) Extra names
40(not provided in \code{...}) are ignored.}
41
42\item{ignore}{Character vector of variables to ignore, never
43returned. (Generally one can control this by not adding the
44variable in the first place, but having this here allows some
45sanity checks and/or programmatic usage.)}
46}
47\value{
48list, generally a list of embedded lists
49}
50\description{
51Convert arguments for a single call into Map-able args
52}