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 bf988f9 commit c71daee
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 21 deletions.
36 changes: 22 additions & 14 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -733,19 +733,19 @@ <h2 id="description">Description</h2>
vignette for complete list of citations for the methods implemented.</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;ammistability&#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;ammistability&#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>devtools<span class="sc">::</span><span class="fu">install_github</span>(<span class="st">&quot;ajaygpb/ammistability&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>devtools<span class="sc">::</span><span class="fu">install_github</span>(<span class="st">&quot;ajaygpb/ammistability&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;ammistability&#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;ammistability&#39;</span>)</span></code></pre></div>
<p>The vignette for the latest version is also available <a href="https://ajaygpb.github.io/ammistability/articles/Introduction.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;ammistability&#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;ammistability&#39;</span>)</span></code></pre></div>
<h2 id="links">Links</h2>
<p><a href="https://cran.r-project.org/package=ammistability">CRAN
page</a></p>
Expand Down Expand Up @@ -816,20 +816,28 @@ <h2 id="cran-checks">CRAN checks</h2>
</table>
<h2 id="citing-ammistability">Citing <code>ammistability</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;ammistability&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;ammistability&quot;</span>)</span></code></pre></div>
<pre><code>To cite the R package &#39;ammistability&#39; in publications use:

Ajay, B. C., Aravind, J., and Abdul Fiyaz, R. (2019). ammistability: R package for ranking genotypes based on stability parameters
derived from AMMI model. Indian Journal of Genetics and Plant Breeding (The), 79(2), 460-466.
Ajay, B. C., Aravind, J., and Abdul Fiyaz, R. (2019). ammistability:
R package for ranking genotypes based on stability parameters derived
from AMMI model. Indian Journal of Genetics and Plant Breeding (The),
79(2), 460-466.
https://www.isgpb.org/article/ammistability-r-package-for-ranking-genotypes-based-on-stability-parameters-derived-from-ammi-model

Ajay, B. C., Aravind, J., and Abdul Fiyaz, R. (). ammistability: Additive Main Effects and Multiplicative Interaction Model Stability
Parameters. R package version 0.1.4.9000, https://ajaygpb.github.io/ammistability/, https://CRAN.R-project.org/package=ammistability.
Ajay, B. C., Aravind, J., and Abdul Fiyaz, R. (). ammistability:
Additive Main Effects and Multiplicative Interaction Model Stability
Parameters. R package version 0.1.4.9000,
https://ajaygpb.github.io/ammistability/,
https://CRAN.R-project.org/package=ammistability.

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.

To see these entries in BibTeX format, use &#39;print(&lt;citation&gt;, bibtex=TRUE)&#39;, &#39;toBibtex(.)&#39;, or set &#39;options(citation.bibtex.max=999)&#39;.</code></pre>
To see these entries in BibTeX format, use &#39;print(&lt;citation&gt;,
bibtex=TRUE)&#39;, &#39;toBibtex(.)&#39;, or set
&#39;options(citation.bibtex.max=999)&#39;.</code></pre>

</body>
</html>
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,14 +229,22 @@ citation("ammistability")

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

Ajay, B. C., Aravind, J., and Abdul Fiyaz, R. (2019). ammistability: R package for ranking genotypes based on stability parameters
derived from AMMI model. Indian Journal of Genetics and Plant Breeding (The), 79(2), 460-466.
Ajay, B. C., Aravind, J., and Abdul Fiyaz, R. (2019). ammistability:
R package for ranking genotypes based on stability parameters derived
from AMMI model. Indian Journal of Genetics and Plant Breeding (The),
79(2), 460-466.
https://www.isgpb.org/article/ammistability-r-package-for-ranking-genotypes-based-on-stability-parameters-derived-from-ammi-model

Ajay, B. C., Aravind, J., and Abdul Fiyaz, R. (). ammistability: Additive Main Effects and Multiplicative Interaction Model Stability
Parameters. R package version 0.1.4.9000, https://ajaygpb.github.io/ammistability/, https://CRAN.R-project.org/package=ammistability.
Ajay, B. C., Aravind, J., and Abdul Fiyaz, R. (). ammistability:
Additive Main Effects and Multiplicative Interaction Model Stability
Parameters. R package version 0.1.4.9000,
https://ajaygpb.github.io/ammistability/,
https://CRAN.R-project.org/package=ammistability.

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.

To see these entries in BibTeX format, use 'print(<citation>, bibtex=TRUE)', 'toBibtex(.)', or set 'options(citation.bibtex.max=999)'.
To see these entries in BibTeX format, use 'print(<citation>,
bibtex=TRUE)', 'toBibtex(.)', or set
'options(citation.bibtex.max=999)'.

0 comments on commit c71daee

Please sign in to comment.