File indexing completed on 2024-05-12 04:02:10
0001 <!DOCTYPE html> 0002 <html><head> 0003 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> 0004 <title>test.Rd</title> 0005 <meta name="generator" content="KF5::SyntaxHighlighting - Definition (R documentation) - Theme (Breeze Light)"/> 0006 </head><body style="background-color:#ffffff;color:#1f1c1b"><pre> 0007 <span style="color:#898887">% Single-line comment</span> 0008 <span style="font-weight:bold">\name</span><span style="color:#ca60ca">{</span><span style="color:#ff5500">foo</span><span style="color:#ca60ca">}</span> 0009 <span style="color:#006e28">#ifdef </span><span style="color:#644a9b;font-weight:bold">unix</span> 0010 <span style="font-weight:bold">\alias</span><span style="color:#ca60ca">{</span><span style="color:#e31616">bar</span><span style="color:#ca60ca">}</span> 0011 <span style="color:#006e28">#endif</span><span style="color:#898887"> ignored</span> 0012 <span style="font-weight:bold">\title</span><span style="color:#ca60ca">{</span>Foo<span style="color:#ca60ca">}</span> 0013 <span style="font-weight:bold">\description</span><span style="color:#ca60ca">{</span> 0014 We have a list 0015 <span style="font-weight:bold">\itemize</span><span style="color:#ca60ca">{</span> 0016 <span style="font-weight:bold">\item</span> foo, 0017 <span style="font-weight:bold">\item</span> bar. 0018 <span style="color:#ca60ca">}</span> 0019 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> 0020 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> 0021 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> 0022 <span style="color:#ca60ca">}</span> 0023 <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> 0024 <span style="color:#ca60ca">}</span> 0025 <span style="font-weight:bold">\section</span><span style="color:#ca60ca">{</span><span style="color:#ff5500">Section</span><span style="color:#ca60ca">}{</span> 0026 Escaped braces don't need balance <span style="color:#3daee9">\}</span> 0027 <span style="font-weight:bold">\subsection</span><span style="color:#ca60ca">{</span><span style="color:#ff5500">Subsection</span><span style="color:#ca60ca">}{</span> 0028 <span style="font-weight:bold">\subsection</span><span style="color:#ca60ca">{</span><span style="color:#ff5500">Subsubsection</span><span style="color:#ca60ca">}{</span> 0029 Sections can be nested. 0030 <span style="color:#ca60ca">}</span> 0031 <span style="color:#ca60ca">}</span> 0032 <span style="color:#ca60ca">}</span> 0033 <span style="font-weight:bold">\usage</span><span style="color:#ca60ca">{</span> 0034 <span style="color:#644a9b">foo</span>(a, <span style="color:#0057ae">b =</span> default) 0035 <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) 0036 <span style="color:#ca60ca">}</span> 0037 <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> 0038 <span style="font-weight:bold">\arguments</span><span style="color:#ca60ca">{</span> 0039 <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> 0040 <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> 0041 <span style="color:#ca60ca">}</span> 0042 <span style="font-weight:bold">\value</span><span style="color:#ca60ca">{</span> 0043 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>. 0044 <span style="color:#ca60ca">}</span> 0045 <span style="font-weight:bold">\seealso</span><span style="color:#ca60ca">{</span> 0046 <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> 0047 <span style="color:#ca60ca">}</span> 0048 <span style="font-weight:bold">\examples</span><span style="color:#ca60ca">{</span> 0049 <span style="color:#898887"># R comment</span> 0050 <span style="color:#898887">% Rdoc comment</span> 0051 <span style="color:#644a9b">foo</span>(<span style="color:#b08000">1</span>) 0052 <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> 0053 <span style="font-weight:bold">\dontrun</span><span style="color:#ca60ca">{</span><span style="color:#e31616">foo(3)</span><span style="color:#ca60ca">}</span> 0054 <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>) 0055 <span style="color:#644a9b">foo</span>(i) 0056 <span style="color:#ca60ca">}</span> 0057 <span style="font-weight:bold">\keyword</span><span style="color:#ca60ca">{</span><span style="color:#ff5500">foo</span><span style="color:#ca60ca">}</span> 0058 </pre></body></html>