mirror of
https://github.com/msberends/AMR.git
synced 2025-09-05 11:29:38 +02:00
(v1.5.0.9006) major documentation update
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
% Please edit documentation in R/availability.R
|
||||
\name{availability}
|
||||
\alias{availability}
|
||||
\title{Check availability of columns}
|
||||
\title{Check Availability of Columns}
|
||||
\usage{
|
||||
availability(tbl, width = NULL)
|
||||
}
|
||||
@@ -20,7 +20,7 @@ Easy check for data availability of all columns in a data set. This makes it eas
|
||||
\details{
|
||||
The function returns a \link{data.frame} with columns \code{"resistant"} and \code{"visual_resistance"}. The values in that columns are calculated with \code{\link[=resistance]{resistance()}}.
|
||||
}
|
||||
\section{Stable lifecycle}{
|
||||
\section{Stable Lifecycle}{
|
||||
|
||||
\if{html}{\figure{lifecycle_stable.svg}{options: style=margin-bottom:5px} \cr}
|
||||
The \link[=lifecycle]{lifecycle} of this function is \strong{stable}. 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.
|
||||
@@ -28,7 +28,7 @@ The \link[=lifecycle]{lifecycle} of this function is \strong{stable}. In a stabl
|
||||
If the unlying code needs breaking changes, they will occur gradually. For example, a 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.
|
||||
}
|
||||
|
||||
\section{Read more on our website!}{
|
||||
\section{Read more on Our Website!}{
|
||||
|
||||
On our website \url{https://msberends.github.io/AMR/} you can find \href{https://msberends.github.io/AMR/articles/AMR.html}{a comprehensive tutorial} about how to conduct AMR analysis, the \href{https://msberends.github.io/AMR/reference/}{complete documentation of all functions} and \href{https://msberends.github.io/AMR/articles/WHONET.html}{an example analysis using WHONET data}. As we would like to better understand the backgrounds and needs of our users, please \href{https://msberends.github.io/AMR/survey.html}{participate in our survey}!
|
||||
}
|
||||
|
Reference in New Issue
Block a user