Deploying to gh-pages from @ b59f189 🚀

index.html

@@ -284,9 +284,13 @@ <h2 class="anchored" data-anchor-id="why">Why?</h2>
 </section>
 <section id="installation" class="level2">
 <h2 class="anchored" data-anchor-id="installation">Installation</h2>
-<p>You can install <code>tinytable</code> from <a href="https://github.com/">GitHub</a> with:</p>
-<div class="sourceCode" id="cb1"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">library</span>(remotes)</span>
-<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="fu">install_github</span>(<span class="st">"vincentarelbundock/tinytable"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+<p>Install the stable version from CRAN:</p>
+<div class="sourceCode" id="cb1"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="st">```</span><span class="at">r</span></span>
+<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="at">install.packages("tinytable")</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+<p><code>tinytable</code> is a relatively new package with rapid development. If you want to benefit from the latest features—showcased on the package website—you may want to install the development version from Github.</p>
+<div class="sourceCode" id="cb2"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">library</span>(remotes)</span>
+<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="fu">install_github</span>(<span class="st">"vincentarelbundock/tinytable"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+<p>Restart <code>R</code> completely for the installation to take effect.</p>
 </section>
 <section id="get-started" class="level2">
 <h2 class="anchored" data-anchor-id="get-started">Get started</h2>

man/format_tt.html

@@ -264,7 +264,6 @@ <h3 class="anchored" data-anchor-id="usage">Usage</h3>
 <pre><code class="language-R">format_tt(
   x,
   j = NULL,
-  output = NULL,
   digits = getOption("digits"),
   num_fmt = "significant",
   num_zero = TRUE,
@@ -301,14 +300,6 @@ <h3 class="anchored" data-anchor-id="arguments">Arguments</h3>
 </tr>
 <tr>
 <td style="white-space: nowrap; font-family: monospace; vertical-align: top">
-<code id="format_tt_:_output">output</code>
-</td>
-<td>
-The format of the output table. Can be "html", "latex", or "markdown". If NULL, the format is automatically detected in Quarto or Rmarkdown documents.
-</td>
-</tr>
-<tr>
-<td style="white-space: nowrap; font-family: monospace; vertical-align: top">
 <code id="format_tt_:_digits">digits</code>
 </td>
 <td>
@@ -422,7 +413,7 @@ <h3 class="anchored" data-anchor-id="examples">Examples</h3>
 
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>tinytable_m85x59getrwuwul11vf2</title>
+    <title>tinytable_twvx4s9r2loyu0rmcfhu</title>
     <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css" rel="stylesheet">
     <style>
     </style>
@@ -442,7 +433,7 @@ <h3 class="anchored" data-anchor-id="examples">Examples</h3>
 
 
     <div class="container">
-      <table class="table" id="tinytable_m85x59getrwuwul11vf2" style="width: auto; margin-left: auto; margin-right: auto;" data-quarto-disable-processing="true">
+      <table class="table" id="tinytable_twvx4s9r2loyu0rmcfhu" style="width: auto; margin-left: auto; margin-right: auto;" data-quarto-disable-processing="true">
         <thead>
 
               <tr>
@@ -453,15 +444,15 @@ <h3 class="anchored" data-anchor-id="examples">Examples</h3>
 
         <tbody>
                 <tr>
-                  <td> 9 999</td>
-                  <td>10 001</td>
+                  <td>10 000</td>
+                  <td>10 000</td>
                 </tr>
                 <tr>
+                  <td> 9 996</td>
                   <td>10 001</td>
-                  <td> 9 999</td>
                 </tr>
                 <tr>
-                  <td> 9 999</td>
+                  <td>10 000</td>
                   <td>10 000</td>
                 </tr>
         </tbody>
@@ -470,12 +461,12 @@ <h3 class="anchored" data-anchor-id="examples">Examples</h3>
 
     <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
     <script>
-    function styleCell_m85x59getrwuwul11vf2(i, j, css_id) {
-      var table = document.getElementById("tinytable_m85x59getrwuwul11vf2");
+    function styleCell_twvx4s9r2loyu0rmcfhu(i, j, css_id) {
+      var table = document.getElementById("tinytable_twvx4s9r2loyu0rmcfhu");
       table.rows[i].cells[j].classList.add(css_id);
     }
     function insertSpanRow(i, colspan, content) {
-      var table = document.getElementById('tinytable_m85x59getrwuwul11vf2');
+      var table = document.getElementById('tinytable_twvx4s9r2loyu0rmcfhu');
       var newRow = table.insertRow(i);
       var newCell = newRow.insertCell(0);
       newCell.setAttribute("colspan", colspan);

man/group_tt.html

@@ -210,6 +210,7 @@ <h2 id="toc-title">On this page</h2>
   <li><a href="#description" id="toc-description" class="nav-link" data-scroll-target="#description">Description</a></li>
   <li><a href="#usage" id="toc-usage" class="nav-link" data-scroll-target="#usage">Usage</a></li>
   <li><a href="#arguments" id="toc-arguments" class="nav-link" data-scroll-target="#arguments">Arguments</a></li>
+  <li><a href="#value" id="toc-value" class="nav-link" data-scroll-target="#value">Value</a></li>
   </ul></li>
   </ul>
 </nav>
@@ -268,6 +269,10 @@ <h3 class="anchored" data-anchor-id="arguments">Arguments</h3>
 </tr>
 
 </tbody></table>
+</section>
+<section id="value" class="level3">
+<h3 class="anchored" data-anchor-id="value">Value</h3>
+<p>An object of class <code>tt</code> representing the table.</p>
 
 
 </section>

man/save_tt.html

@@ -263,7 +263,7 @@ <h3 class="anchored" data-anchor-id="description">Description</h3>
 </section>
 <section id="usage" class="level3">
 <h3 class="anchored" data-anchor-id="usage">Usage</h3>
-<pre><code class="language-R">save_tt(x, filename, overwrite = FALSE)
+<pre><code class="language-R">save_tt(x, output, overwrite = FALSE)
 </code></pre>
 </section>
 <section id="arguments" class="level3">
@@ -280,10 +280,18 @@ <h3 class="anchored" data-anchor-id="arguments">Arguments</h3>
 </tr>
 <tr>
 <td style="white-space: nowrap; font-family: monospace; vertical-align: top">
-<code id="save_tt_:_filename">filename</code>
+<code id="save_tt_:_output">output</code>
 </td>
 <td>
-A string representing the path to the file where the object should be saved. The supported file formats are: .html, .png, .md, .pdf, and .tex.
+<p>String or file path.</p>
+<ul>
+<li>
+<p>If <code>output</code> is "markdown", "latex", or "html", the table is returned in a string as an <code>R</code> object.</p>
+</li>
+<li>
+<p>If <code>output</code> is a valid file path, the table is saved to file. The supported extensions are: .html, .png, .pdf, .tex and .md (with aliases .txt, .Rmd and .qmd).</p>
+</li>
+</ul>
 </td>
 </tr>
 <tr>
@@ -299,7 +307,7 @@ <h3 class="anchored" data-anchor-id="arguments">Arguments</h3>
 </section>
 <section id="value" class="level3">
 <h3 class="anchored" data-anchor-id="value">Value</h3>
-<p>invisible(TRUE)</p>
+<p>A string or <code>TRUE</code> when the table is written to file.</p>
 </section>
 <section id="examples" class="level3">
 <h3 class="anchored" data-anchor-id="examples">Examples</h3>
@@ -308,8 +316,8 @@ <h3 class="anchored" data-anchor-id="examples">Examples</h3>
 <span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a></span>
 <span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a></span>
 <span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a><span class="fu">library</span>(tinytable)</span>
-<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a>tab  <span class="ot">&lt;-</span> <span class="fu">tt</span>(mtcars[<span class="dv">1</span><span class="sc">:</span><span class="dv">4</span>, <span class="dv">1</span><span class="sc">:</span><span class="dv">4</span>])</span>
-<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a><span class="fu">save_tt</span>(tt, <span class="st">"path/to/file.txt"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a>filename <span class="ot">&lt;-</span> <span class="fu">file.path</span>(<span class="fu">tempdir</span>(), <span class="st">"table.tex"</span>)</span>
+<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a><span class="fu">tt</span>(mtcars[<span class="dv">1</span><span class="sc">:</span><span class="dv">4</span>, <span class="dv">1</span><span class="sc">:</span><span class="dv">4</span>]) <span class="sc">|&gt;</span> <span class="fu">save_tt</span>(filename)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 </div>
 
 

man/style_tt.html

@@ -487,7 +487,7 @@ <h3 class="anchored" data-anchor-id="arguments">Arguments</h3>
 </section>
 <section id="value" class="level3">
 <h3 class="anchored" data-anchor-id="value">Value</h3>
-<p>Returns a modified <code>tinytable</code> object with the applied styles.</p>
+<p>An object of class <code>tt</code> representing the table.</p>
 </section>
 <section id="latex-preamble" class="level3">
 <h3 class="anchored" data-anchor-id="latex-preamble">LaTeX preamble</h3>