| 1 |
<!DOCTYPE html> |
| 2 |
<html><head> |
| 3 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> |
| 4 |
<title>test.Rd</title> |
| 5 |
<meta name="generator" content="KF5::SyntaxHighlighting - Definition (R documentation) - Theme (Breeze Light)"/> |
| 6 |
</head><body style="background-color:#ffffff;color:#1f1c1b"><pre> |
| 7 |
<span style="color:#898887;">% Single-line comment</span> |
| 8 |
<span style="font-weight:bold;">\name</span><span style="color:#ca60ca;">{</span><span style="color:#ff5500;">foo</span><span style="color:#ca60ca;">}</span> |
| 9 |
<span style="color:#006e28;">#ifdef </span><span style="color:#644a9b;font-weight:bold;">unix</span> |
| 10 |
<span style="font-weight:bold;">\alias</span><span style="color:#ca60ca;">{</span><span style="color:#e31616;">bar</span><span style="color:#ca60ca;">}</span> |
| 11 |
<span style="color:#006e28;">#endif</span><span style="color:#898887;"> ignored</span> |
| 12 |
<span style="font-weight:bold;">\title</span><span style="color:#ca60ca;">{</span>Foo<span style="color:#ca60ca;">}</span> |
| 13 |
<span style="font-weight:bold;">\description</span><span style="color:#ca60ca;">{</span> |
| 14 |
We have a list |
| 15 |
<span style="font-weight:bold;">\itemize</span><span style="color:#ca60ca;">{</span> |
| 16 |
<span style="font-weight:bold;">\item</span> foo, |
| 17 |
<span style="font-weight:bold;">\item</span> bar. |
| 18 |
<span style="color:#ca60ca;">}</span> |
| 19 |
Also a table: <span style="font-weight:bold;">\tabular</span><span style="color:#ca60ca;">{</span><span style="color:#e31616;">lr</span><span style="color:#ca60ca;">}{</span> |
| 20 |
foo <span style="color:#644a9b;">\tab</span> <span style="font-weight:bold;">\code</span><span style="color:#ca60ca;">{</span><span style="color:#e31616;">foo</span><span style="color:#ca60ca;">}</span> <span style="color:#644a9b;">\cr</span> |
| 21 |
bar <span style="color:#644a9b;">\tab</span> <span style="font-weight:bold;">\preformatted</span><span style="color:#ca60ca;">{</span><span style="color:#e31616;">bar</span><span style="color:#ca60ca;">}</span> |
| 22 |
<span style="color:#ca60ca;">}</span> |
| 23 |
<span style="font-weight:bold;">\samp</span><span style="color:#bf0303;text-decoration:underline;"> error</span><span style="color:#ca60ca;">{</span>code<span style="color:#ca60ca;">}</span> |
| 24 |
<span style="color:#ca60ca;">}</span> |
| 25 |
<span style="font-weight:bold;">\section</span><span style="color:#ca60ca;">{</span><span style="color:#ff5500;">Section</span><span style="color:#ca60ca;">}{</span> |
| 26 |
Escaped braces don't need balance <span style="color:#3daee9;">\}</span> |
| 27 |
<span style="font-weight:bold;">\subsection</span><span style="color:#ca60ca;">{</span><span style="color:#ff5500;">Subsection</span><span style="color:#ca60ca;">}{</span> |
| 28 |
<span style="font-weight:bold;">\subsection</span><span style="color:#ca60ca;">{</span><span style="color:#ff5500;">Subsubsection</span><span style="color:#ca60ca;">}{</span> |
| 29 |
Sections can be nested. |
| 30 |
<span style="color:#ca60ca;">}</span> |
| 31 |
<span style="color:#ca60ca;">}</span> |
| 32 |
<span style="color:#ca60ca;">}</span> |
| 33 |
<span style="font-weight:bold;">\usage</span><span style="color:#ca60ca;">{</span> |
| 34 |
<span style="color:#644a9b;">foo</span>(a, <span style="color:#0057ae;">b =</span> default) |
| 35 |
<span style="font-weight:bold;">\method</span><span style="color:#ca60ca;">{</span><span style="color:#ff5500;">[</span><span style="color:#ca60ca;">}{</span>foo<span style="color:#ca60ca;">}</span>(x, \dots) |
| 36 |
<span style="color:#ca60ca;">}</span> |
| 37 |
<span style="font-weight:bold;">\newcommand</span><span style="color:#ca60ca;">{</span><span style="color:#644a9b;">\macro</span><span style="color:#ca60ca;">}{</span>Test<span style="color:#0057ae;">#1</span><span style="color:#ca60ca;">}</span> |
| 38 |
<span style="font-weight:bold;">\arguments</span><span style="color:#ca60ca;">{</span> |
| 39 |
<span style="font-weight:bold;">\item</span><span style="color:#ca60ca;">{</span><span style="color:#ff5500;">a</span><span style="color:#ca60ca;">}{</span><span style="font-weight:bold;">\if</span><span style="color:#ca60ca;">{</span><span style="color:#644a9b;font-weight:bold;">html</span><span style="color:#ca60ca;">}{</span>&pi; =<span style="color:#ca60ca;">}</span> <span style="font-weight:bold;">\Sexpr</span><span style="color:#ca60ca;">[</span><span style="color:#e31616;">stage=build</span><span style="color:#ca60ca;">]{</span><span style="color:#b08000;">4</span><span style="color:#3daee9;">*</span><span style="color:#644a9b;">atan</span>(<span style="color:#b08000;">1</span>)<span style="color:#ca60ca;">}}</span> |
| 40 |
<span style="font-weight:bold;">\item</span><span style="color:#ca60ca;">{</span><span style="color:#644a9b;">\dots</span><span style="color:#ca60ca;">}{</span><span style="color:#644a9b;">\macro</span><span style="color:#ca60ca;">{</span>text<span style="color:#ca60ca;">}</span> <span style="font-weight:bold;">\link</span><span style="color:#ca60ca;">[</span><span style="color:#e31616;">pkg:bar</span><span style="color:#ca60ca;">]{</span><span style="color:#ff5500;">fooo</span><span style="color:#ca60ca;">}}</span> |
| 41 |
<span style="color:#ca60ca;">}</span> |
| 42 |
<span style="font-weight:bold;">\value</span><span style="color:#ca60ca;">{</span> |
| 43 |
Return a <span style="font-weight:bold;">\code</span><span style="color:#ca60ca;">{</span><span style="font-weight:bold;">\link</span><span style="color:#ca60ca;">{</span><span style="color:#ff5500;">foo</span><span style="color:#ca60ca;">}}</span>. |
| 44 |
<span style="color:#ca60ca;">}</span> |
| 45 |
<span style="font-weight:bold;">\seealso</span><span style="color:#ca60ca;">{</span> |
| 46 |
<span style="font-weight:bold;">\code</span><span style="color:#ca60ca;">{</span><span style="font-weight:bold;">\link</span><span style="color:#ca60ca;">{</span><span style="color:#ff5500;">bar</span><span style="color:#ca60ca;">}}</span> |
| 47 |
<span style="color:#ca60ca;">}</span> |
| 48 |
<span style="font-weight:bold;">\examples</span><span style="color:#ca60ca;">{</span> |
| 49 |
<span style="color:#898887;"># R comment</span> |
| 50 |
<span style="color:#898887;">% Rdoc comment</span> |
| 51 |
<span style="color:#644a9b;">foo</span>(<span style="color:#b08000;">1</span>) |
| 52 |
<span style="font-weight:bold;">\donttest</span><span style="color:#ca60ca;">{</span><span style="color:#644a9b;">foo</span>(<span style="color:#b08000;">2</span>)<span style="color:#ca60ca;">}</span> |
| 53 |
<span style="font-weight:bold;">\dontrun</span><span style="color:#ca60ca;">{</span><span style="color:#e31616;">foo(3)</span><span style="color:#ca60ca;">}</span> |
| 54 |
<span style="font-weight:bold;">for</span> (i <span style="font-weight:bold;">in</span> <span style="color:#b08000;">1</span><span style="color:#3daee9;">:</span><span style="color:#b08000;">10</span>) |
| 55 |
<span style="color:#644a9b;">foo</span>(i) |
| 56 |
<span style="color:#ca60ca;">}</span> |
| 57 |
<span style="font-weight:bold;">\keyword</span><span style="color:#ca60ca;">{</span><span style="color:#ff5500;">foo</span><span style="color:#ca60ca;">}</span> |
| 58 |
</pre></body></html> |