1% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/iteratelist.R
3\name{iteratelist}
4\alias{iteratelist}
5\title{Create an iteration list from a R object}
6\usage{
7iteratelist(x, name = "name", value = "value")
8}
9\arguments{
10\item{x}{\code{list} or other object that will be coerced to \code{list}}
11
12\item{name}{\code{character} name for resulting name member.}
13
14\item{value}{\code{character} name for resulting value member.}
15}
16\value{
17unnamed \code{list} with name value lists
18}
19\description{
20In some case it is useful to iterate over a named \code{list} or \code{vector}
21\code{iteratelist} will create a new unnamed \code{list} with name value members:
22each item will be a list where 'name' is the corresponding name and 'value' is the original
23value in list \code{x}.
24}
25\examples{
26# create an iteration list from a named vector
27x <- c(a=1, b=2)
28iteratelist(x)
29
30# iterate over the members of a list
31x <- list(name="John", age="30", gender="male")
32iteratelist(x, name="variable")
33
34# iterate over an unnamed vector
35values <- c(1,2,3,4)
36
37template <-
38'{{#values}}
39* Value: {{.}}
40{{/values}}'
41
42whisker.render(template)
43
44#or
45
46values <- iteratelist(values, value="count")
47
48template <-
49'{{#values}}
50* Value: {{count}}
51{{/values}}'
52
53whisker.render(template)
54}
55