P281424/AMR
1
0
Fork 0
mirror of https://github.com/msberends/AMR.git synced 2025-07-17 13:53:17 +02:00
Code Releases Activity

(v1.8.0.9001) as.mo improvement, fixes #52

Browse Source
This commit is contained in:
dr. M.S. (Matthijs) Berends
2022-02-26 21:58:23 +01:00
parent be792cc9eb
commit 18e8525d10
108 changed files with 568 additions and 399 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/reference/lifecycle.html
View File

@ -19,7 +19,7 @@ This page contains a section for every lifecycle (with text borrowed from the af
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">AMR (for R)</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.8.0</span>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.8.0.9001</span>
</span>
</div>
@ -161,31 +161,30 @@ This page contains a section for every lifecycle (with text borrowed from the af
<div class="ref-description">
<p>Functions in this <code>AMR</code> package are categorised using <a href="https://lifecycle.r-lib.org/articles/stages.html" class="external-link">the lifecycle circle of the Tidyverse as found on www.tidyverse.org/lifecycle</a>.</p>
<p><img src="figures/lifecycle_tidyverse.svg" height="200px" style="margin-bottom:5px"><br>
<p><img src="figures/lifecycle_tidyverse.svg" height="200" style='margin-bottom:"5"'><br>
This page contains a section for every lifecycle (with text borrowed from the aforementioned Tidyverse website), so they can be used in the manual pages of the functions.</p>
</div>
<div id="ref-usage">Usage,NULL</div>
<div id="experimental-lifecycle">
<h2>Experimental Lifecycle</h2>
<p><img src="figures/lifecycle_experimental.svg" style="margin-bottom:5px"><br>
<p><img src="figures/lifecycle_experimental.svg" style='margin-bottom:"5"'><br>
The lifecycle of this function is <strong>experimental</strong>. An experimental function is in early stages of development. The unlying code might be changing frequently. Experimental functions might be removed without deprecation, so you are generally best off waiting until a function is more mature before you use it in production code. Experimental functions are only available in development versions of this <code>AMR</code> package and will thus not be included in releases that are submitted to CRAN, since such functions have not yet matured enough.</p>
</div>
<div id="maturing-lifecycle">
<h2>Maturing Lifecycle</h2>
<p><img src="figures/lifecycle_maturing.svg" style="margin-bottom:5px"><br>
<p><img src="figures/lifecycle_maturing.svg" style='margin-bottom:"5"'><br>
The lifecycle of this function is <strong>maturing</strong>. The unlying code of a maturing function has been roughed out, but finer details might still change. Since this function needs wider usage and more extensive testing, you are very welcome <a href="https://github.com/msberends/AMR/issues" class="external-link">to suggest changes at our repository</a> or <a href="AMR.html">write us an email (see section 'Contact Us')</a>.</p>
</div>
<div id="stable-lifecycle">
<h2>Stable Lifecycle</h2>
<p><img src="figures/lifecycle_stable.svg" style="margin-bottom:5px"><br>
<p><img src="figures/lifecycle_stable.svg" style='margin-bottom:"5"'><br>
The lifecycle of this function is <strong>stable</strong>. In a stable function, major changes are unlikely. This means that the unlying code will generally evolve by adding new arguments; removing arguments or changing the meaning of existing arguments will be avoided.</p>
<p>If the unlying code needs breaking changes, they will occur gradually. For example, an argument will be deprecated and first continue to work, but will emit an message informing you of the change. Next, typically after at least one newly released version on CRAN, the message will be transformed to an error.</p>
</div>
@ -193,14 +192,14 @@ The lifecycle of this function is <strong>stable</strong>. In a stable function,
<h2>Retired Lifecycle</h2>
<p><img src="figures/lifecycle_retired.svg" style="margin-bottom:5px"><br>
<p><img src="figures/lifecycle_retired.svg" style='margin-bottom:"5"'><br>
The lifecycle of this function is <strong>retired</strong>. A retired function is no longer under active development, and (if appropiate) a better alternative is available. No new arguments will be added, and only the most critical bugs will be fixed. In a future version, this function will be removed.</p>
</div>
<div id="questioning-lifecycle">
<h2>Questioning Lifecycle</h2>
<p><img src="figures/lifecycle_questioning.svg" style="margin-bottom:5px"><br>
<p><img src="figures/lifecycle_questioning.svg" style='margin-bottom:"5"'><br>
The lifecycle of this function is <strong>questioning</strong>. This function might be no longer be optimal approach, or is it questionable whether this function should be in this <code>AMR</code> package at all.</p>
</div>
@ -216,7 +215,7 @@ The lifecycle of this function is <strong>questioning</strong>. This function mi
</div>
<div class="pkgdown">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.0.</p>
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.2.</p>
</div>
</footer></div>