Bladeren bron

roxygenize -> 7.1.0

master
Garrick Aden-Buie 6 jaren geleden
bovenliggende
commit
44da17177a
19 gewijzigde bestanden met toevoegingen van 222 en 122 verwijderingen
  1. +1
    -1
      DESCRIPTION
  2. +7
    -6
      man/bulma_color.Rd
  3. +9
    -2
      man/bulma_column.Rd
  4. +8
    -2
      man/bulma_column_options.Rd
  5. +10
    -3
      man/bulma_columns.Rd
  6. +3
    -2
      man/bulma_constants.Rd
  7. +53
    -34
      man/bulma_document.Rd
  8. +7
    -6
      man/bulma_helper.Rd
  9. +17
    -8
      man/bulma_level.Rd
  10. +4
    -3
      man/bulma_level_item.Rd
  11. +12
    -4
      man/bulma_level_item_header.Rd
  12. +11
    -4
      man/bulma_level_items_header.Rd
  13. +13
    -5
      man/bulma_message.Rd
  14. +7
    -6
      man/bulma_modifier.Rd
  15. +7
    -5
      man/bulma_responsive.Rd
  16. +7
    -5
      man/bulma_responsive_alignment.Rd
  17. +7
    -5
      man/bulma_responsive_size.Rd
  18. +22
    -13
      man/bulma_sidenote.Rd
  19. +17
    -8
      man/bulma_typography.Rd

+ 1
- 1
DESCRIPTION Bestand weergeven

@@ -27,7 +27,7 @@ Imports:
rmarkdown
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.1.1
RoxygenNote: 7.1.0
Roxygen: list(markdown = TRUE)
Suggests:
testthat

+ 7
- 6
man/bulma_color.Rd Bestand weergeven

@@ -32,11 +32,12 @@ bulma_color("white", "primary")
\url{https://bulma.io/documentation/modifiers/color-helpers}
}
\seealso{
Other Bulma modifiers: \code{\link{bulma_helper}},
\code{\link{bulma_modifier}},
\code{\link{bulma_responsive_alignment}},
\code{\link{bulma_responsive_size}},
\code{\link{bulma_responsive}},
\code{\link{bulma_typography}}
Other Bulma modifiers:
\code{\link{bulma_helper}()},
\code{\link{bulma_modifier}()},
\code{\link{bulma_responsive_alignment}()},
\code{\link{bulma_responsive_size}()},
\code{\link{bulma_responsive}()},
\code{\link{bulma_typography}()}
}
\concept{Bulma modifiers}

+ 9
- 2
man/bulma_column.Rd Bestand weergeven

@@ -4,8 +4,15 @@
\alias{bulma_column}
\title{Bulma Column}
\usage{
bulma_column(..., size = NULL, width = NULL, offset = NULL,
narrow = NULL, class = NULL, style = NULL)
bulma_column(
...,
size = NULL,
width = NULL,
offset = NULL,
narrow = NULL,
class = NULL,
style = NULL
)
}
\arguments{
\item{size}{One of "full", "four-fifths", "three-quarters", "two-thirds",

+ 8
- 2
man/bulma_column_options.Rd Bestand weergeven

@@ -4,8 +4,14 @@
\alias{bulma_column_options}
\title{Bulma Column Options}
\usage{
bulma_column_options(size = NULL, width = NULL, offset = NULL,
narrow = NULL, class = NULL, style = NULL)
bulma_column_options(
size = NULL,
width = NULL,
offset = NULL,
narrow = NULL,
class = NULL,
style = NULL
)
}
\arguments{
\item{size}{One of "full", "four-fifths", "three-quarters", "two-thirds",

+ 10
- 3
man/bulma_columns.Rd Bestand weergeven

@@ -4,9 +4,16 @@
\alias{bulma_columns}
\title{Bulma Columns}
\usage{
bulma_columns(..., breakpoint = "tablet", gap = NULL,
multiline = TRUE, centered = FALSE, class = NULL, style = NULL,
column_options = NULL)
bulma_columns(
...,
breakpoint = "tablet",
gap = NULL,
multiline = TRUE,
centered = FALSE,
class = NULL,
style = NULL,
column_options = NULL
)
}
\arguments{
\item{breakpoint}{By default, columns are only activated from \strong{tablet}

+ 3
- 2
man/bulma_constants.Rd Bestand weergeven

@@ -4,8 +4,9 @@
\alias{bulma_constants}
\title{Bulma Constants}
\usage{
bulma_constants(variable = c("colors", "column sizes", "viewports",
"alignment"))
bulma_constants(
variable = c("colors", "column sizes", "viewports", "alignment")
)
}
\arguments{
\item{variable}{One of "colors", "column sizes", "viewports"}

+ 53
- 34
man/bulma_document.Rd Bestand weergeven

@@ -4,13 +4,60 @@
\alias{bulma_document}
\title{Bulma Document Renderer}
\usage{
bulma_document(..., css = NULL, fig_width = 10, fig_height = 7,
fig_retina = 2, keep_md = FALSE, dev = "png", toc = FALSE,
toc_depth = 3, mathjax = "default", pandoc_args = NULL,
extra_dependencies = NULL)
bulma_document(
...,
css = NULL,
fig_width = 10,
fig_height = 7,
fig_retina = 2,
keep_md = FALSE,
dev = "png",
toc = FALSE,
toc_depth = 3,
mathjax = "default",
pandoc_args = NULL,
extra_dependencies = NULL,
self_contained = TRUE
)
}
\arguments{
\item{...}{Ignored}
\item{...}{
Arguments passed on to \code{\link[rmarkdown:html_document_base]{rmarkdown::html_document_base}}
\describe{
\item{\code{smart}}{Produce typographically correct output, converting straight
quotes to curly quotes, \code{---} to em-dashes, \code{--} to en-dashes, and
\code{...} to ellipses.}
\item{\code{theme}}{Visual theme ("default", "cerulean", "cosmo", "cyborg", "darkly",
"flatly", "journal", "lumen", "readable", "sandstone", "simplex", "slate",
"spacelab", "superhero", "united", or "yeti"). Pass \code{NULL} for no
theme (in this case you can use the \code{css} parameter to add your own styles).
If Bootstrap 4+ is used (see \code{bootstrap_version} argument),
a handful of other themes are available ("lux", "minty", "pulse",
"sketchy", and "solar"). Moreover, with Bootstrap 4+, custom
\href{https://getbootstrap.com/docs/4.0/getting-started/theming/}{Bootstrap
themes} are supported via the \code{bs_theme_add_variables()} and
\code{bs_theme_add()} functions from the bootstraplib package
(use these functions from within the document).}
\item{\code{lib_dir}}{Directory to copy dependent HTML libraries (e.g. jquery,
bootstrap, etc.) into. By default this will be the name of the document with
\code{_files} appended to it.}
\item{\code{template}}{Pandoc template to use for rendering. Pass "default" to use
the rmarkdown package default template; pass \code{NULL} to use pandoc's
built-in template; pass a path to use a custom template that you've created.
Note that if you don't use the "default" template then some features of
\code{html_document} won't be available (see the Templates section below for
more details).}
\item{\code{dependency_resolver}}{A dependency resolver}
\item{\code{copy_resources}}{Copy resources}
\item{\code{bootstrap_compatible}}{Bootstrap compatible}
\item{\code{bootstrap_version}}{version of Bootstrap to use (relevant if \code{theme}
is not \code{NULL}). Currently three options are supported: Bootstrap version
3.x (\code{3}), Bootstrap version 4.x (\code{4}), and Bootstrap version 4.x
with additional JS/CSS to support BS3 style nav, navbar, and other component
styling (\code{"4+3"}). Use this version if you want to upgrade to Bootstrap 4
while maintaining the functionality of a document already written with
Bootstrap 3 in mind.}
}}

\item{mathjax}{Include mathjax. The "default" option uses an https URL from a
MathJax CDN. The "local" option uses a local version of MathJax (which is
@@ -21,39 +68,11 @@ copied into the output directory). You can pass an alternate URL or pass

\item{extra_dependencies}{Extra dependencies}

\item{...}{Arguments passed on to \code{rmarkdown::html_document_base}
\describe{
\item{smart}{Produce typographically correct output, converting straight
quotes to curly quotes, --- to em-dashes, -- to en-dashes, and ... to
ellipses.}
\item{theme}{Visual theme ("default", "cerulean", "journal", "flatly",
"darkly", "readable", "spacelab", "united", "cosmo", "lumen", "paper",
"sandstone", "simplex", or "yeti"). Pass \code{NULL} for no theme (in this
case you can use the \code{css} parameter to add your own styles).}
\item{self_contained}{Produce a standalone HTML file with no external
\item{self_contained}{Produce a standalone HTML file with no external
dependencies, using data: URIs to incorporate the contents of linked
scripts, stylesheets, images, and videos. Note that even for self contained
documents MathJax is still loaded externally (this is necessary because of
its size).}
\item{lib_dir}{Directory to copy dependent HTML libraries (e.g. jquery,
bootstrap, etc.) into. By default this will be the name of the document with
\code{_files} appended to it.}
\item{mathjax}{Include mathjax. The "default" option uses an https URL from a
MathJax CDN. The "local" option uses a local version of MathJax (which is
copied into the output directory). You can pass an alternate URL or pass
\code{NULL} to exclude MathJax entirely.}
\item{pandoc_args}{Additional command line options to pass to pandoc}
\item{template}{Pandoc template to use for rendering. Pass "default" to use
the rmarkdown package default template; pass \code{NULL} to use pandoc's
built-in template; pass a path to use a custom template that you've created.
Note that if you don't use the "default" template then some features of
\code{html_document} won't be available (see the Templates section below for
more details).}
\item{dependency_resolver}{A dependency resolver}
\item{copy_resources}{Copy resources}
\item{extra_dependencies}{Extra dependencies}
\item{bootstrap_compatible}{Bootstrap compatible}
}}
}
\description{
Bulma Document Renderer

+ 7
- 6
man/bulma_helper.Rd Bestand weergeven

@@ -48,11 +48,12 @@ bulma_helper(other = "clipped", float = "pulled-right")
\url{https://bulma.io/documentation/modifiers/helpers}
}
\seealso{
Other Bulma modifiers: \code{\link{bulma_color}},
\code{\link{bulma_modifier}},
\code{\link{bulma_responsive_alignment}},
\code{\link{bulma_responsive_size}},
\code{\link{bulma_responsive}},
\code{\link{bulma_typography}}
Other Bulma modifiers:
\code{\link{bulma_color}()},
\code{\link{bulma_modifier}()},
\code{\link{bulma_responsive_alignment}()},
\code{\link{bulma_responsive_size}()},
\code{\link{bulma_responsive}()},
\code{\link{bulma_typography}()}
}
\concept{Bulma modifiers}

+ 17
- 8
man/bulma_level.Rd Bestand weergeven

@@ -4,13 +4,21 @@
\alias{bulma_level}
\title{Bulma Level}
\usage{
bulma_level(..., left = NULL, right = NULL, is_mobile = TRUE,
type = c("item", "header"), container_tag = c("div", "nav"),
class = NULL, style = NULL, level_class = NULL,
level_style = NULL)
bulma_level(
...,
left = NULL,
right = NULL,
is_mobile = TRUE,
type = c("item", "header"),
container_tag = c("div", "nav"),
class = NULL,
style = NULL,
level_class = NULL,
level_style = NULL
)
}
\arguments{
\item{...}{Items to be wrapped in a \code{"level-item"} \code{<div>} and included in the
\item{...}{Items to be wrapped in a \code{"level-item"} \verb{<div>} and included in the
main level container. If only one argument is provided and that argument is
a list, the items inside the list will be treated as individual level items.}

@@ -53,8 +61,9 @@ bulma_level(iris_vals, type = "header")
\url{https://bulma.io/documentation/layout/level/}
}
\seealso{
Other Bulma layouts: \code{\link{bulma_level_item_header}},
\code{\link{bulma_level_items_header}},
\code{\link{bulma_level_item}}
Other Bulma layouts:
\code{\link{bulma_level_item_header}()},
\code{\link{bulma_level_items_header}()},
\code{\link{bulma_level_item}()}
}
\concept{Bulma layouts}

+ 4
- 3
man/bulma_level_item.Rd Bestand weergeven

@@ -17,8 +17,9 @@ bulma_level_item(..., class = NULL, style = NULL)
Constructs an individual level item.
}
\seealso{
Other Bulma layouts: \code{\link{bulma_level_item_header}},
\code{\link{bulma_level_items_header}},
\code{\link{bulma_level}}
Other Bulma layouts:
\code{\link{bulma_level_item_header}()},
\code{\link{bulma_level_items_header}()},
\code{\link{bulma_level}()}
}
\concept{Bulma layouts}

+ 12
- 4
man/bulma_level_item_header.Rd Bestand weergeven

@@ -4,8 +4,14 @@
\alias{bulma_level_item_header}
\title{Bulma Level Item with Header}
\usage{
bulma_level_item_header(item_header, item_body, class = NULL,
style = NULL, header_class = NULL, body_class = NULL)
bulma_level_item_header(
item_header,
item_body,
class = NULL,
style = NULL,
header_class = NULL,
body_class = NULL
)
}
\arguments{
\item{item_body}{The body of the item}
@@ -26,7 +32,9 @@ container in addition to \code{"title"}}
Constructs an individual level item with a header (upper) and a title (lower).
}
\seealso{
Other Bulma layouts: \code{\link{bulma_level_items_header}},
\code{\link{bulma_level_item}}, \code{\link{bulma_level}}
Other Bulma layouts:
\code{\link{bulma_level_items_header}()},
\code{\link{bulma_level_item}()},
\code{\link{bulma_level}()}
}
\concept{Bulma layouts}

+ 11
- 4
man/bulma_level_items_header.Rd Bestand weergeven

@@ -4,8 +4,13 @@
\alias{bulma_level_items_header}
\title{Bulma Level Items with Headers}
\usage{
bulma_level_items_header(..., class = NULL, style = NULL,
header_class = NULL, body_class = NULL)
bulma_level_items_header(
...,
class = NULL,
style = NULL,
header_class = NULL,
body_class = NULL
)
}
\arguments{
\item{...}{Elements to be included in the level item}
@@ -25,7 +30,9 @@ Takes named arguments and converts them to
(level items with headers)\link{bulma_level_item_header}.
}
\seealso{
Other Bulma layouts: \code{\link{bulma_level_item_header}},
\code{\link{bulma_level_item}}, \code{\link{bulma_level}}
Other Bulma layouts:
\code{\link{bulma_level_item_header}()},
\code{\link{bulma_level_item}()},
\code{\link{bulma_level}()}
}
\concept{Bulma layouts}

+ 13
- 5
man/bulma_message.Rd Bestand weergeven

@@ -4,9 +4,16 @@
\alias{bulma_message}
\title{Bulma Message}
\usage{
bulma_message(..., header = NULL, delete = FALSE, color = NULL,
size = c("normal", "small", "medium", "large"), width = NULL,
centered = !is.null(width), column_class = NULL)
bulma_message(
...,
header = NULL,
delete = FALSE,
color = NULL,
size = c("normal", "small", "medium", "large"),
width = NULL,
centered = !is.null(width),
column_class = NULL
)
}
\arguments{
\item{...}{Message body}
@@ -18,7 +25,7 @@ bulma_message(..., header = NULL, delete = FALSE, color = NULL,
\item{size}{Text size, one of \code{"small"}, \code{"normal"} (default),
\code{"medium"}, or \code{"large"}.}

\item{width}{Width of the message. If \code{NULL} then width is 100% of container.
\item{width}{Width of the message. If \code{NULL} then width is 100\% of container.
If specified, the message is wrapped in a \code{column} div (see \code{\link[=bulma_column]{bulma_column()}}
for more information and for valid column sizes).}

@@ -36,6 +43,7 @@ Creates a message box with optional title bar.
\url{https://bulma.io/documentation/components/message/}
}
\seealso{
Other Bulma components: \code{\link{bulma_sidenote}}
Other Bulma components:
\code{\link{bulma_sidenote}()}
}
\concept{Bulma components}

+ 7
- 6
man/bulma_modifier.Rd Bestand weergeven

@@ -28,11 +28,12 @@ bulma_modifier(color = "primary", size = "large", state = "outlined")
\url{https://bulma.io/documentation/modifiers/syntax/}
}
\seealso{
Other Bulma modifiers: \code{\link{bulma_color}},
\code{\link{bulma_helper}},
\code{\link{bulma_responsive_alignment}},
\code{\link{bulma_responsive_size}},
\code{\link{bulma_responsive}},
\code{\link{bulma_typography}}
Other Bulma modifiers:
\code{\link{bulma_color}()},
\code{\link{bulma_helper}()},
\code{\link{bulma_responsive_alignment}()},
\code{\link{bulma_responsive_size}()},
\code{\link{bulma_responsive}()},
\code{\link{bulma_typography}()}
}
\concept{Bulma modifiers}

+ 7
- 5
man/bulma_responsive.Rd Bestand weergeven

@@ -27,10 +27,12 @@ bulma_responsive("flex", "widescreen", only = TRUE)
\url{https://bulma.io/documentation/modifiers/responsive-helpers/}
}
\seealso{
Other Bulma modifiers: \code{\link{bulma_color}},
\code{\link{bulma_helper}}, \code{\link{bulma_modifier}},
\code{\link{bulma_responsive_alignment}},
\code{\link{bulma_responsive_size}},
\code{\link{bulma_typography}}
Other Bulma modifiers:
\code{\link{bulma_color}()},
\code{\link{bulma_helper}()},
\code{\link{bulma_modifier}()},
\code{\link{bulma_responsive_alignment}()},
\code{\link{bulma_responsive_size}()},
\code{\link{bulma_typography}()}
}
\concept{Bulma modifiers}

+ 7
- 5
man/bulma_responsive_alignment.Rd Bestand weergeven

@@ -28,10 +28,12 @@ bulma_responsive_alignment(viewport = "widescreen")
\url{https://bulma.io/documentation/modifiers/typography-helpers/#responsive-alignment}
}
\seealso{
Other Bulma modifiers: \code{\link{bulma_color}},
\code{\link{bulma_helper}}, \code{\link{bulma_modifier}},
\code{\link{bulma_responsive_size}},
\code{\link{bulma_responsive}},
\code{\link{bulma_typography}}
Other Bulma modifiers:
\code{\link{bulma_color}()},
\code{\link{bulma_helper}()},
\code{\link{bulma_modifier}()},
\code{\link{bulma_responsive_size}()},
\code{\link{bulma_responsive}()},
\code{\link{bulma_typography}()}
}
\concept{Bulma modifiers}

+ 7
- 5
man/bulma_responsive_size.Rd Bestand weergeven

@@ -25,10 +25,12 @@ bulma_responsive_size(2, "tablet")
bulma_responsive_size(viewport = "widescreen")
}
\seealso{
Other Bulma modifiers: \code{\link{bulma_color}},
\code{\link{bulma_helper}}, \code{\link{bulma_modifier}},
\code{\link{bulma_responsive_alignment}},
\code{\link{bulma_responsive}},
\code{\link{bulma_typography}}
Other Bulma modifiers:
\code{\link{bulma_color}()},
\code{\link{bulma_helper}()},
\code{\link{bulma_modifier}()},
\code{\link{bulma_responsive_alignment}()},
\code{\link{bulma_responsive}()},
\code{\link{bulma_typography}()}
}
\concept{Bulma modifiers}

+ 22
- 13
man/bulma_sidenote.Rd Bestand weergeven

@@ -4,26 +4,34 @@
\alias{bulma_sidenote}
\title{Bulma Message as a Sidenote}
\usage{
bulma_sidenote(..., side = c("right", "left"), header = NULL,
color = NULL, size = c("small", "normal", "medium", "large"),
width = "one-third", delete = FALSE, column_class = NULL)
bulma_sidenote(
...,
side = c("right", "left"),
header = NULL,
color = NULL,
size = c("small", "normal", "medium", "large"),
width = "one-third",
delete = FALSE,
column_class = NULL
)
}
\arguments{
\item{...}{Arguments passed on to \code{bulma_message}
\describe{
\item{header}{Message header}
\item{delete}{Should delete button be displayed in upper right corner?}
\item{size}{Text size, one of \code{"small"}, \code{"normal"} (default),
\item{...}{
Arguments passed on to \code{\link[=bulma_message]{bulma_message}}
\describe{
\item{\code{header}}{Message header}
\item{\code{delete}}{Should delete button be displayed in upper right corner?}
\item{\code{size}}{Text size, one of \code{"small"}, \code{"normal"} (default),
\code{"medium"}, or \code{"large"}.}
\item{width}{Width of the message. If \code{NULL} then width is 100% of container.
\item{\code{width}}{Width of the message. If \code{NULL} then width is 100\% of container.
If specified, the message is wrapped in a \code{column} div (see \code{\link[=bulma_column]{bulma_column()}}
for more information and for valid column sizes).}
\item{centered}{Should the message container be centered horizontally?
\item{\code{centered}}{Should the message container be centered horizontally?
Requires \code{width} to be specified. If \code{TRUE}, the message container is
inside a \code{column} div inside a \code{columns} div.}
\item{column_class}{Additional parameters passed to the \code{class} argument
\item{\code{column_class}}{Additional parameters passed to the \code{class} argument
of the \code{column} div. Only used if \code{width} is specified.}
}}
}}

\item{side}{Should the sidenote be pulled to the left or the right?}
}
@@ -38,6 +46,7 @@ bulma_sidenote("A sidenote!", side = "right", color = "info",
\seealso{
\code{\link[=bulma_message]{bulma_message()}}

Other Bulma components: \code{\link{bulma_message}}
Other Bulma components:
\code{\link{bulma_message}()}
}
\concept{Bulma components}

+ 17
- 8
man/bulma_typography.Rd Bestand weergeven

@@ -4,9 +4,16 @@
\alias{bulma_typography}
\title{Bulma Typography Helper Classes}
\usage{
bulma_typography(size = NULL, color = NULL, responsive_size = NULL,
alignment = NULL, responsive_alignment = NULL,
transformation = NULL, weight = NULL, font_family = NULL)
bulma_typography(
size = NULL,
color = NULL,
responsive_size = NULL,
alignment = NULL,
responsive_alignment = NULL,
transformation = NULL,
weight = NULL,
font_family = NULL
)
}
\arguments{
\item{size}{One of 1 through 7 (large to small)}
@@ -42,10 +49,12 @@ bulma_color("white", "primary")
\url{https://bulma.io/documentation/modifiers/typography-helpers/}
}
\seealso{
Other Bulma modifiers: \code{\link{bulma_color}},
\code{\link{bulma_helper}}, \code{\link{bulma_modifier}},
\code{\link{bulma_responsive_alignment}},
\code{\link{bulma_responsive_size}},
\code{\link{bulma_responsive}}
Other Bulma modifiers:
\code{\link{bulma_color}()},
\code{\link{bulma_helper}()},
\code{\link{bulma_modifier}()},
\code{\link{bulma_responsive_alignment}()},
\code{\link{bulma_responsive_size}()},
\code{\link{bulma_responsive}()}
}
\concept{Bulma modifiers}

Laden…
Annuleren
Opslaan