Skip to content

Commit

Permalink
Re-build README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Aug 20, 2023
1 parent 670f03c commit 11f5003
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 16 deletions.
26 changes: 14 additions & 12 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -642,20 +642,20 @@ <h2 id="description">Description</h2>
report generation functions.</p>
<h2 id="installation">Installation</h2>
<p>The package can be installed from CRAN as follows:</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb1-1"><a href="#cb1-1" tabindex="-1"></a><span class="co"># Install from CRAN</span></span>
<span id="cb1-2"><a href="#cb1-2" tabindex="-1"></a><span class="fu">install.packages</span>(<span class="st">&#39;augmentedRCBD&#39;</span>, <span class="at">dependencies=</span><span class="cn">TRUE</span>)</span></code></pre></div>
<div class="sourceCode" id="cb1"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Install from CRAN</span></span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="fu">install.packages</span>(<span class="st">&#39;augmentedRCBD&#39;</span>, <span class="at">dependencies=</span><span class="cn">TRUE</span>)</span></code></pre></div>
<p>The development version can be installed from github as follows:</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb2-1"><a href="#cb2-1" tabindex="-1"></a><span class="co"># Install development version from Github</span></span>
<span id="cb2-2"><a href="#cb2-2" tabindex="-1"></a><span class="cf">if</span> (<span class="sc">!</span><span class="fu">require</span>(<span class="st">&#39;devtools&#39;</span>)) <span class="fu">install.packages</span>(<span class="st">&#39;devtools&#39;</span>)</span>
<span id="cb2-3"><a href="#cb2-3" tabindex="-1"></a>devtools<span class="sc">::</span><span class="fu">install_github</span>(<span class="st">&quot;aravind-j/augmentedRCBD&quot;</span>)</span></code></pre></div>
<div class="sourceCode" id="cb2"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Install development version from Github</span></span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="cf">if</span> (<span class="sc">!</span><span class="fu">require</span>(<span class="st">&#39;devtools&#39;</span>)) <span class="fu">install.packages</span>(<span class="st">&#39;devtools&#39;</span>)</span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a>devtools<span class="sc">::</span><span class="fu">install_github</span>(<span class="st">&quot;aravind-j/augmentedRCBD&quot;</span>)</span></code></pre></div>
<h2 id="detailed-tutorial">Detailed tutorial</h2>
<p>For a detailed tutorial (vignette) on how to used this package
type:</p>
<div class="sourceCode" id="cb3"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb3-1"><a href="#cb3-1" tabindex="-1"></a><span class="fu">browseVignettes</span>(<span class="at">package =</span> <span class="st">&#39;augmentedRCBD&#39;</span>)</span></code></pre></div>
<div class="sourceCode" id="cb3"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="fu">browseVignettes</span>(<span class="at">package =</span> <span class="st">&#39;augmentedRCBD&#39;</span>)</span></code></pre></div>
<p>The vignette for the latest version is also available <a href="https://aravind-j.github.io/augmentedRCBD/articles/Data_Analysis_with_augmentedRCBD.html">online</a>.</p>
<h2 id="whats-new">What’s new</h2>
<p>To know whats new in this version type:</p>
<div class="sourceCode" id="cb4"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb4-1"><a href="#cb4-1" tabindex="-1"></a><span class="fu">news</span>(<span class="at">package=</span><span class="st">&#39;augmentedRCBD&#39;</span>)</span></code></pre></div>
<div class="sourceCode" id="cb4"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="fu">news</span>(<span class="at">package=</span><span class="st">&#39;augmentedRCBD&#39;</span>)</span></code></pre></div>
<h2 id="links">Links</h2>
<p><a href="https://cran.r-project.org/package=augmentedRCBD">CRAN
page</a></p>
Expand Down Expand Up @@ -726,11 +726,12 @@ <h2 id="cran-checks">CRAN checks</h2>
</table>
<h2 id="citing-augmentedrcbd">Citing <code>augmentedRCBD</code></h2>
<p>To cite the methods in the package use:</p>
<div class="sourceCode" id="cb5"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb5-1"><a href="#cb5-1" tabindex="-1"></a><span class="fu">citation</span>(<span class="st">&quot;augmentedRCBD&quot;</span>)</span></code></pre></div>
<div class="sourceCode" id="cb5"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="fu">citation</span>(<span class="st">&quot;augmentedRCBD&quot;</span>)</span></code></pre></div>
<pre><code>To cite the R package &#39;augmentedRCBD&#39; in publications use:

Aravind, J., Mukesh Sankar, S., Wankhede, D. P., and Kaur, V. (). augmentedRCBD: Analysis of Augmented
Randomised Complete Block Designs. R package version 0.1.7.9000,
Aravind, J., Mukesh Sankar, S., Wankhede, D. P., and Kaur, V. ().
augmentedRCBD: Analysis of Augmented Randomised Complete Block
Designs. R package version 0.1.7.9000,
https://aravind-j.github.io/augmentedRCBD/https://cran.r-project.org/package=augmentedRCBD.

A BibTeX entry for LaTeX users is
Expand All @@ -741,8 +742,9 @@ <h2 id="citing-augmentedrcbd">Citing <code>augmentedRCBD</code></h2>
note = {R package version 0.1.7.9000 https://aravind-j.github.io/augmentedRCBD/ https://cran.r-project.org/package=augmentedRCBD},
}

This free and open-source software implements academic research by the authors and co-workers. If you use
it, please support the project by citing the package.</code></pre>
This free and open-source software implements academic research by the
authors and co-workers. If you use it, please support the project by
citing the package.</code></pre>

</body>
</html>
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,9 @@ citation("augmentedRCBD")

To cite the R package 'augmentedRCBD' in publications use:

Aravind, J., Mukesh Sankar, S., Wankhede, D. P., and Kaur, V. (). augmentedRCBD: Analysis of Augmented
Randomised Complete Block Designs. R package version 0.1.7.9000,
Aravind, J., Mukesh Sankar, S., Wankhede, D. P., and Kaur, V. ().
augmentedRCBD: Analysis of Augmented Randomised Complete Block
Designs. R package version 0.1.7.9000,
https://aravind-j.github.io/augmentedRCBD/https://cran.r-project.org/package=augmentedRCBD.

A BibTeX entry for LaTeX users is
Expand All @@ -152,5 +153,6 @@ citation("augmentedRCBD")
note = {R package version 0.1.7.9000 https://aravind-j.github.io/augmentedRCBD/ https://cran.r-project.org/package=augmentedRCBD},
}

This free and open-source software implements academic research by the authors and co-workers. If you use
it, please support the project by citing the package.
This free and open-source software implements academic research by the
authors and co-workers. If you use it, please support the project by
citing the package.

0 comments on commit 11f5003

Please sign in to comment.