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
|
<!DOCTYPE html>
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>test.Rd</title>
<meta name="generator" content="KF5::SyntaxHighlighting - Definition (R documentation) - Theme (Breeze Dark)"/>
</head><body style="background-color:#232629;color:#cfcfc2"><pre>
<span style="color:#7a7c7d">% Single-line comment</span>
<span style="color:#fdbc4b;font-weight:bold">\name</span><span style="color:#3f8058">{</span><span style="color:#da4453">foo</span><span style="color:#3f8058">}</span>
<span style="color:#27ae60">#ifdef </span><span style="color:#7f8c8d">unix</span>
<span style="color:#fdbc4b;font-weight:bold">\alias</span><span style="color:#3f8058">{</span><span style="color:#da4453">bar</span><span style="color:#3f8058">}</span>
<span style="color:#27ae60">#endif</span><span style="color:#7a7c7d"> ignored</span>
<span style="color:#fdbc4b;font-weight:bold">\title</span><span style="color:#3f8058">{</span>Foo<span style="color:#3f8058">}</span>
<span style="color:#fdbc4b;font-weight:bold">\description</span><span style="color:#3f8058">{</span>
We have a list
<span style="font-weight:bold">\itemize</span><span style="color:#3f8058">{</span>
<span style="font-weight:bold">\item</span> foo,
<span style="font-weight:bold">\item</span> bar.
<span style="color:#3f8058">}</span>
Also a table: <span style="font-weight:bold">\tabular</span><span style="color:#3f8058">{</span><span style="color:#da4453">lr</span><span style="color:#3f8058">}{</span>
foo <span style="color:#8e44ad">\tab</span> <span style="font-weight:bold">\code</span><span style="color:#3f8058">{</span><span style="color:#da4453">foo</span><span style="color:#3f8058">}</span> <span style="color:#8e44ad">\cr</span>
bar <span style="color:#8e44ad">\tab</span> <span style="font-weight:bold">\preformatted</span><span style="color:#3f8058">{</span><span style="color:#da4453">bar</span><span style="color:#3f8058">}</span>
<span style="color:#3f8058">}</span>
<span style="font-weight:bold">\samp</span><span style="color:#da4453;text-decoration:underline"> error</span><span style="color:#3f8058">{</span>code<span style="color:#3f8058">}</span>
<span style="color:#3f8058">}</span>
<span style="color:#fdbc4b;font-weight:bold">\section</span><span style="color:#3f8058">{</span><span style="color:#da4453">Section</span><span style="color:#3f8058">}{</span>
Escaped braces don't need balance <span style="color:#3daee9">\}</span>
<span style="color:#fdbc4b;font-weight:bold">\subsection</span><span style="color:#3f8058">{</span><span style="color:#da4453">Subsection</span><span style="color:#3f8058">}{</span>
<span style="color:#fdbc4b;font-weight:bold">\subsection</span><span style="color:#3f8058">{</span><span style="color:#da4453">Subsubsection</span><span style="color:#3f8058">}{</span>
Sections can be nested.
<span style="color:#3f8058">}</span>
<span style="color:#3f8058">}</span>
<span style="color:#3f8058">}</span>
<span style="color:#fdbc4b;font-weight:bold">\usage</span><span style="color:#3f8058">{</span>
<span style="color:#8e44ad">foo</span>(a, <span style="color:#2980b9">b =</span> default)
<span style="font-weight:bold">\method</span><span style="color:#3f8058">{</span><span style="color:#da4453">[</span><span style="color:#3f8058">}{</span>foo<span style="color:#3f8058">}</span>(x, \dots)
<span style="color:#3f8058">}</span>
<span style="font-weight:bold">\newcommand</span><span style="color:#3f8058">{</span><span style="color:#8e44ad">\macro</span><span style="color:#3f8058">}{</span>Test<span style="color:#27aeae">#1</span><span style="color:#3f8058">}</span>
<span style="color:#fdbc4b;font-weight:bold">\arguments</span><span style="color:#3f8058">{</span>
<span style="font-weight:bold">\item</span><span style="color:#3f8058">{</span><span style="color:#da4453">a</span><span style="color:#3f8058">}{</span><span style="font-weight:bold">\if</span><span style="color:#3f8058">{</span><span style="color:#7f8c8d">html</span><span style="color:#3f8058">}{</span>&pi; =<span style="color:#3f8058">}</span> <span style="font-weight:bold">\Sexpr</span><span style="color:#3f8058">[</span><span style="color:#da4453">stage=build</span><span style="color:#3f8058">]{</span><span style="color:#f67400">4</span><span style="color:#3daee9">*</span><span style="color:#8e44ad">atan</span>(<span style="color:#f67400">1</span>)<span style="color:#3f8058">}}</span>
<span style="font-weight:bold">\item</span><span style="color:#3f8058">{</span><span style="color:#8e44ad">\dots</span><span style="color:#3f8058">}{</span><span style="color:#8e44ad">\macro</span><span style="color:#3f8058">{</span>text<span style="color:#3f8058">}</span> <span style="font-weight:bold">\link</span><span style="color:#3f8058">[</span><span style="color:#da4453">pkg:bar</span><span style="color:#3f8058">]{</span><span style="color:#da4453">fooo</span><span style="color:#3f8058">}}</span>
<span style="color:#3f8058">}</span>
<span style="color:#fdbc4b;font-weight:bold">\value</span><span style="color:#3f8058">{</span>
Return a <span style="font-weight:bold">\code</span><span style="color:#3f8058">{</span><span style="font-weight:bold">\link</span><span style="color:#3f8058">{</span><span style="color:#da4453">foo</span><span style="color:#3f8058">}}</span>.
<span style="color:#3f8058">}</span>
<span style="color:#fdbc4b;font-weight:bold">\seealso</span><span style="color:#3f8058">{</span>
<span style="font-weight:bold">\code</span><span style="color:#3f8058">{</span><span style="font-weight:bold">\link</span><span style="color:#3f8058">{</span><span style="color:#da4453">bar</span><span style="color:#3f8058">}}</span>
<span style="color:#3f8058">}</span>
<span style="color:#fdbc4b;font-weight:bold">\examples</span><span style="color:#3f8058">{</span>
<span style="color:#7a7c7d"># R comment</span>
<span style="color:#7a7c7d">% Rdoc comment</span>
<span style="color:#8e44ad">foo</span>(<span style="color:#f67400">1</span>)
<span style="font-weight:bold">\donttest</span><span style="color:#3f8058">{</span><span style="color:#8e44ad">foo</span>(<span style="color:#f67400">2</span>)<span style="color:#3f8058">}</span>
<span style="font-weight:bold">\dontrun</span><span style="color:#3f8058">{</span><span style="color:#da4453">foo(3)</span><span style="color:#3f8058">}</span>
<span style="color:#fdbc4b;font-weight:bold">for</span> (i <span style="color:#fdbc4b;font-weight:bold">in</span> <span style="color:#f67400">1</span><span style="color:#3daee9">:</span><span style="color:#f67400">10</span>)
<span style="color:#8e44ad">foo</span>(i)
<span style="color:#3f8058">}</span>
<span style="color:#fdbc4b;font-weight:bold">\keyword</span><span style="color:#3f8058">{</span><span style="color:#da4453">foo</span><span style="color:#3f8058">}</span>
</pre></body></html>
|