/
nested_list.Rd
40 lines (37 loc) · 1.07 KB
/
nested_list.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/nested_list.R
\name{nested_list}
\alias{nested_list}
\title{Output a nested list in RMarkdown list format}
\usage{
nested_list(x, pre = "", quote = "", type = "unordered")
}
\arguments{
\item{x}{The list}
\item{pre}{Text to prefix to each line (e.g., if you want all lines indented 4 spaces to start, use " ")}
\item{quote}{Text to quote values with (e.g., use "`" to make sure values are not parsed as markdown}
\item{type}{Text to specify type of lists (unorderd, ordered, headers)}
}
\value{
A character string
}
\description{
Output a nested list in RMarkdown list format
}
\examples{
x <- list(
a = list(a1 = "Named", a2 = "List"),
b = list("Unnamed", "List"),
c = c(c1 = "Named", c2 = "Vector"),
d = c("Unnamed", "Vector"),
e = list(e1 = list("A", "B", "C"),
e2 = list(a = "A", b = "B"),
e3 = c("A", "B", "C"),
e4 = 100),
f = "single item vector",
g = list()
)
nested_list(x)
nested_list(x, pre = " ")
nested_list(x, type = "headers", pre= "#", quote = "'")
}