toRd.shiny.tag-methods: Methods for 'toRd.shiny.tag'
In RDocTaskForce/htmlRd: Convert Shiny HTML tags into Rd format
Description
Usage
Arguments
Methods (by HTML tag)
See Also
Examples
Description
Methods for toRd.shiny.tag().
Usage
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# Special Methods ------------------------------------------------------
## Default S3 method:
toRd.shiny.tag(obj, ...)
## S3 method for class 'shiny.tag'
toRd.shiny.tag(obj, ...)
# Defined Methods ------------------------------------------------------
## S3 method for class 'a'
toRd.shiny.tag(obj, ...)
## S3 method for class 'abbr'
toRd.shiny.tag(obj, ..., abbr.check.caps=TRUE)
## S3 method for class 'br'
toRd.shiny.tag(obj, ...)
## S3 method for class 'code'
toRd.shiny.tag(obj, ...)
## S3 method for class 'div'
toRd.shiny.tag(obj, ..., sub.section=FALSE)
## S3 method for class 'dfn'
toRd.shiny.tag(obj, ...)
## S3 method for class 'dd'
toRd.shiny.tag(obj, ...)
## S3 method for class 'dt'
toRd.shiny.tag(obj, ...)
## S3 method for class 'dl'
toRd.shiny.tag(obj, ...)
## S3 method for class 'html'
toRd.shiny.tag(obj, ...)
## S3 method for class 'img'
toRd.shiny.tag(obj, ...)
## S3 method for class 'li'
toRd.shiny.tag(obj, ...)
## S3 method for class 'p'
toRd.shiny.tag(obj, ...)
## S3 method for class 'ol'
toRd.shiny.tag(obj, ...)
## S3 method for class 'section'
toRd.shiny.tag(obj, ..., sub.section=FALSE)
## S3 method for class 'table'
toRd.shiny.tag(obj, ..., col.align = 'l')
## S3 method for class 'tr'
toRd.shiny.tag(obj, ..., head=FALSE)
## S3 method for class 'tbody'
toRd.shiny.tag(obj, ..., head=FALSE)
## S3 method for class 'tfoot'
toRd.shiny.tag(obj, ..., warn.info.loss = "message")
## S3 method for class 'thead'
toRd.shiny.tag(obj, ...)
## S3 method for class 'ul'
toRd.shiny.tag(obj, ...)
# Generated Methods ----------------------------------------------------
## Extractors ==========================================================
## S3 method for class 'h1'
toRd.shiny.tag(obj, ..., warn.info.loss="warning")
## S3 method for class 'h2'
toRd.shiny.tag(obj, ..., warn.info.loss="warning")
## S3 method for class 'h3'
toRd.shiny.tag(obj, ..., warn.info.loss="warning")
## S3 method for class 'h4'
toRd.shiny.tag(obj, ..., warn.info.loss="warning")
## S3 method for class 'h5'
toRd.shiny.tag(obj, ..., warn.info.loss="warning")
## S3 method for class 'span'
toRd.shiny.tag(obj, ..., warn.info.loss="warning")
## S3 method for class 'td'
toRd.shiny.tag(obj, ..., warn.info.loss="none")
## S3 method for class 'th'
toRd.shiny.tag(obj, ..., warn.info.loss="message")
## Converters ==========================================================
## S3 method for class 'aside'
toRd.shiny.tag(obj, ...)
## S3 method for class 'em'
toRd.shiny.tag(obj, ...)
## S3 method for class 'cite'
toRd.shiny.tag(obj, ...)
## S3 method for class 'kbd'
toRd.shiny.tag(obj, ...)
## S3 method for class 'pre'
toRd.shiny.tag(obj, ...)
## S3 method for class 'q'
toRd.shiny.tag(obj, ...)
## S3 method for class 'samp'
toRd.shiny.tag(obj, ...)
## S3 method for class 'strong'
toRd.shiny.tag(obj, ...)
Arguments
obj
a shiny.tag object.
...
passed to methods.
warn.info.loss
should warning be issued when information
might be lost. Note that defaults are different for
different methods.
abbr.check.caps
Check is abbreviations in all caps.
col.align
Column alignment for tables.
head
Used internally to indicate if a child of a <thead> node.
sub.section
Used internally for nested <section>s
and <div>s.
Methods (by HTML tag)
Special Methods
These are defined for completeness but always produce errors.
-
toRd.shiny.tag.default: Generates informative error, but should not
be called in the normal course of execution.
-
toRd.shiny.tag.shiny.tag: If no method exists to explicitly handle
the tag an error is generated.
Defined Methods
-
toRd.shiny.tag.a: <a> is converted to \link if a link
to another help file, or is converted to \href if a url scheme
is detected, and may throw an error if the link cannot be
determined to be either.
-
toRd.shiny.tag.abbr: <abbr> is converted to \acronym.
May not have children.
Will warn if abbreviation is not in all caps,
use abbr.check.caps=FALSE to disable.
-
toRd.shiny.tag.br: <br> is converted to \cr.
May not have children.
-
toRd.shiny.tag.code: <code> is converted to \code.
-
toRd.shiny.tag.div: See toRd.shiny.tag.section.
-
toRd.shiny.tag.dfn: <dfn> is converted to \dfn.
Must have a single plain text element.
-
toRd.shiny.tag.dd: Used with <dl> extraction.
-
toRd.shiny.tag.dt: Used with <dt> extraction.
-
toRd.shiny.tag.dl:
<dl>
<dt>term</dt>
<dd>definition</dd>
...
</dl> is converted to
\describe{
\item{term}
{definition}}.
-
toRd.shiny.tag.html: <html> is converted to Rd container.
-
toRd.shiny.tag.img: <img> is converted to \figure.
HTML must contain a "src" attribute.
-
toRd.shiny.tag.li: <li> is converted to \item.
-
toRd.shiny.tag.p: <p> is converted to Rd container of
content with two newlines appended for paragraph break.
-
toRd.shiny.tag.ol: <ol> is converted to \enumerate.
May only contain <li> nodes.
-
toRd.shiny.tag.section: <section> is converted to \section or
\subsection, depending on nesting.
Must be able to determine a title, otherwise will
generate an error.
-
toRd.shiny.tag.table: <table> is converted to \tabular.
Table rows are separated with \cr and columns within
rows by \tab.
May only contain <thead>, <tbody>, and
<tfoot> type nodes, and must contain a
<tbody> node.
Note that column and row spans are not currently supported.
-
toRd.shiny.tag.tr: Table row.
Used with <thead>, <tbody>, and <tfoot>.
Cells of table row are returned in an Rd container
separated by \tab tags.
May only contain <td> nodes unless it is contained in
a <thead> node then must contain <th> nodes.
-
toRd.shiny.tag.tbody: Table body.
Returns rows of the table body in an Rd container
separated by \cr tags.
May only contain <tr> nodes.
-
toRd.shiny.tag.tfoot: Table footer.
Same as tbody with the added message warning that
information will be lost as the portion of the table that
was the footer will no longer be identifiable.
-
toRd.shiny.tag.thead: Table header.
Same as tbody and and tfoot except the
information loss message is given as a warning.
-
toRd.shiny.tag.ul: <ul> is converted to \itemize.
May only contain <li> nodes.
Generated Methods
These methods are generated.
Extractors: Only extract the contents but do not wrap
in an Rd tag.
-
toRd.shiny.tag.h1: extract with warning
-
toRd.shiny.tag.h2: extract with warning
-
toRd.shiny.tag.h3: extract with warning
-
toRd.shiny.tag.h4: extract with warning
-
toRd.shiny.tag.h5: extract with warning
-
toRd.shiny.tag.span: extract with warning
-
toRd.shiny.tag.td: extracts silently by default.
-
toRd.shiny.tag.th: extract, but with a message.
Converters: Convert simply from an HTML tag to an Rd tag.
-
toRd.shiny.tag.aside: <aside> is converted to \note
-
toRd.shiny.tag.em: <em> is converted to \emph
-
toRd.shiny.tag.cite: <cite> is converted to \cite
-
toRd.shiny.tag.kbd: <kbd> is converted to \kbd
-
toRd.shiny.tag.pre: <pre> is converted to \preformatted
-
toRd.shiny.tag.q: <q> is converted to \dQuote
-
toRd.shiny.tag.samp: <samp> is converted to \preformatted
-
toRd.shiny.tag.strong: <strong> is converted to \strong
See Also
Root generic: toRd
Sub Generic: toRd.shiny.tag
Generators: toRd.shiny.tag-generators
Examples
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
toRd(htmltools::a("some text", href="https://r-project.org"))
toRd(htmltools::tags$abbr("GPL"))
toRd(htmltools::code("plot(rnorm(100))"))
toRd(htmltools::tags$dfn("abc"))
toRd(htmltools::tags$dl( htmltools::tags$dt("term1")
, htmltools::tags$dd("definition 1.")
, htmltools::tags$dt("term2")
, htmltools::tags$dd("definition 2.")
))
toRd(htmltools::tags$ol( htmltools::tags$li("First")
, htmltools::tags$li("Second")
))
toRd(htmltools::tags$ul( htmltools::tags$li("First")
, htmltools::tags$li("Second")
))
RDocTaskForce/htmlRd documentation built on May 13, 2019, 10:04 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Methods (by HTML tag) See Also Examples
Description
Methods for toRd.shiny.tag().
Usage
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 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 | # Special Methods ------------------------------------------------------
## Default S3 method:
toRd.shiny.tag(obj, ...)
## S3 method for class 'shiny.tag'
toRd.shiny.tag(obj, ...)
# Defined Methods ------------------------------------------------------
## S3 method for class 'a'
toRd.shiny.tag(obj, ...)
## S3 method for class 'abbr'
toRd.shiny.tag(obj, ..., abbr.check.caps=TRUE)
## S3 method for class 'br'
toRd.shiny.tag(obj, ...)
## S3 method for class 'code'
toRd.shiny.tag(obj, ...)
## S3 method for class 'div'
toRd.shiny.tag(obj, ..., sub.section=FALSE)
## S3 method for class 'dfn'
toRd.shiny.tag(obj, ...)
## S3 method for class 'dd'
toRd.shiny.tag(obj, ...)
## S3 method for class 'dt'
toRd.shiny.tag(obj, ...)
## S3 method for class 'dl'
toRd.shiny.tag(obj, ...)
## S3 method for class 'html'
toRd.shiny.tag(obj, ...)
## S3 method for class 'img'
toRd.shiny.tag(obj, ...)
## S3 method for class 'li'
toRd.shiny.tag(obj, ...)
## S3 method for class 'p'
toRd.shiny.tag(obj, ...)
## S3 method for class 'ol'
toRd.shiny.tag(obj, ...)
## S3 method for class 'section'
toRd.shiny.tag(obj, ..., sub.section=FALSE)
## S3 method for class 'table'
toRd.shiny.tag(obj, ..., col.align = 'l')
## S3 method for class 'tr'
toRd.shiny.tag(obj, ..., head=FALSE)
## S3 method for class 'tbody'
toRd.shiny.tag(obj, ..., head=FALSE)
## S3 method for class 'tfoot'
toRd.shiny.tag(obj, ..., warn.info.loss = "message")
## S3 method for class 'thead'
toRd.shiny.tag(obj, ...)
## S3 method for class 'ul'
toRd.shiny.tag(obj, ...)
# Generated Methods ----------------------------------------------------
## Extractors ==========================================================
## S3 method for class 'h1'
toRd.shiny.tag(obj, ..., warn.info.loss="warning")
## S3 method for class 'h2'
toRd.shiny.tag(obj, ..., warn.info.loss="warning")
## S3 method for class 'h3'
toRd.shiny.tag(obj, ..., warn.info.loss="warning")
## S3 method for class 'h4'
toRd.shiny.tag(obj, ..., warn.info.loss="warning")
## S3 method for class 'h5'
toRd.shiny.tag(obj, ..., warn.info.loss="warning")
## S3 method for class 'span'
toRd.shiny.tag(obj, ..., warn.info.loss="warning")
## S3 method for class 'td'
toRd.shiny.tag(obj, ..., warn.info.loss="none")
## S3 method for class 'th'
toRd.shiny.tag(obj, ..., warn.info.loss="message")
## Converters ==========================================================
## S3 method for class 'aside'
toRd.shiny.tag(obj, ...)
## S3 method for class 'em'
toRd.shiny.tag(obj, ...)
## S3 method for class 'cite'
toRd.shiny.tag(obj, ...)
## S3 method for class 'kbd'
toRd.shiny.tag(obj, ...)
## S3 method for class 'pre'
toRd.shiny.tag(obj, ...)
## S3 method for class 'q'
toRd.shiny.tag(obj, ...)
## S3 method for class 'samp'
toRd.shiny.tag(obj, ...)
## S3 method for class 'strong'
toRd.shiny.tag(obj, ...)
|
Arguments
obj |
a |
... |
passed to methods. |
warn.info.loss |
should warning be issued when information might be lost. Note that defaults are different for different methods. |
abbr.check.caps |
Check is abbreviations in all caps. |
col.align |
Column alignment for tables. |
head |
Used internally to indicate if a child of a |
sub.section |
Used internally for nested |
Methods (by HTML tag)
Special Methods
These are defined for completeness but always produce errors.
-
toRd.shiny.tag.default: Generates informative error, but should not be called in the normal course of execution. -
toRd.shiny.tag.shiny.tag: If no method exists to explicitly handle the tag an error is generated.
Defined Methods
-
toRd.shiny.tag.a:<a>is converted to\linkif a link to another help file, or is converted to\hrefif a url scheme is detected, and may throw an error if the link cannot be determined to be either. -
toRd.shiny.tag.abbr:<abbr>is converted to\acronym. May not have children. Will warn if abbreviation is not in all caps, useabbr.check.caps=FALSEto disable. -
toRd.shiny.tag.br:<br>is converted to\cr. May not have children. -
toRd.shiny.tag.code:<code>is converted to\code. -
toRd.shiny.tag.div: SeetoRd.shiny.tag.section. -
toRd.shiny.tag.dfn:<dfn>is converted to\dfn. Must have a single plain text element. -
toRd.shiny.tag.dd: Used with<dl>extraction. -
toRd.shiny.tag.dt: Used with<dt>extraction. -
toRd.shiny.tag.dl:<dl><dt>term</dt><dd>definition</dd>...</dl>is converted to\describe{\item{term}{definition}}. -
toRd.shiny.tag.html:<html>is converted toRdcontainer. -
toRd.shiny.tag.img:<img>is converted to\figure. HTML must contain a"src"attribute. -
toRd.shiny.tag.li:<li>is converted to\item. -
toRd.shiny.tag.p:<p>is converted to Rd container of content with two newlines appended for paragraph break. -
toRd.shiny.tag.ol:<ol>is converted to\enumerate. May only contain<li>nodes. -
toRd.shiny.tag.section:<section>is converted to\sectionor\subsection, depending on nesting. Must be able to determine a title, otherwise will generate an error. -
toRd.shiny.tag.table:<table>is converted to\tabular. Table rows are separated with\crand columns within rows by\tab. May only contain<thead>,<tbody>, and<tfoot>type nodes, and must contain a<tbody>node. Note that column and row spans are not currently supported. -
toRd.shiny.tag.tr: Table row. Used with<thead>,<tbody>, and<tfoot>. Cells of table row are returned in anRdcontainer separated by\tabtags. May only contain<td>nodes unless it is contained in a<thead>node then must contain<th>nodes. -
toRd.shiny.tag.tbody: Table body. Returns rows of the table body in anRdcontainer separated by\crtags. May only contain<tr>nodes. -
toRd.shiny.tag.tfoot: Table footer. Same astbodywith the added message warning that information will be lost as the portion of the table that was the footer will no longer be identifiable. -
toRd.shiny.tag.thead: Table header. Same astbodyand andtfootexcept the information loss message is given as a warning. -
toRd.shiny.tag.ul:<ul>is converted to\itemize. May only contain<li>nodes.
Generated Methods
These methods are generated.
Extractors: Only extract the contents but do not wrap in an Rd tag.
-
toRd.shiny.tag.h1: extract with warning -
toRd.shiny.tag.h2: extract with warning -
toRd.shiny.tag.h3: extract with warning -
toRd.shiny.tag.h4: extract with warning -
toRd.shiny.tag.h5: extract with warning -
toRd.shiny.tag.span: extract with warning -
toRd.shiny.tag.td: extracts silently by default. -
toRd.shiny.tag.th: extract, but with a message.
Converters: Convert simply from an HTML tag to an Rd tag.
-
toRd.shiny.tag.aside:<aside>is converted to\note -
toRd.shiny.tag.em:<em>is converted to\emph -
toRd.shiny.tag.cite:<cite>is converted to\cite -
toRd.shiny.tag.kbd:<kbd>is converted to\kbd -
toRd.shiny.tag.pre:<pre>is converted to\preformatted -
toRd.shiny.tag.q:<q>is converted to\dQuote -
toRd.shiny.tag.samp:<samp>is converted to\preformatted -
toRd.shiny.tag.strong:<strong>is converted to\strong
See Also
Root generic:
toRdSub Generic:
toRd.shiny.tagGenerators:
toRd.shiny.tag-generators
Examples
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | toRd(htmltools::a("some text", href="https://r-project.org"))
toRd(htmltools::tags$abbr("GPL"))
toRd(htmltools::code("plot(rnorm(100))"))
toRd(htmltools::tags$dfn("abc"))
toRd(htmltools::tags$dl( htmltools::tags$dt("term1")
, htmltools::tags$dd("definition 1.")
, htmltools::tags$dt("term2")
, htmltools::tags$dd("definition 2.")
))
toRd(htmltools::tags$ol( htmltools::tags$li("First")
, htmltools::tags$li("Second")
))
toRd(htmltools::tags$ul( htmltools::tags$li("First")
, htmltools::tags$li("Second")
))
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.