mirror of https://github.com/msberends/AMR.git
34 lines
1.5 KiB
R
34 lines
1.5 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/p_symbol.R
|
|
\name{p_symbol}
|
|
\alias{p_symbol}
|
|
\title{Symbol of a p-value}
|
|
\usage{
|
|
p_symbol(p, emptychar = " ")
|
|
}
|
|
\arguments{
|
|
\item{p}{p value}
|
|
|
|
\item{emptychar}{text to show when \code{p > 0.1}}
|
|
}
|
|
\value{
|
|
Text
|
|
}
|
|
\description{
|
|
Return the symbol related to the p-value: 0 '\verb{***}' 0.001 '\verb{**}' 0.01 '\code{*}' 0.05 '\code{.}' 0.1 ' ' 1. Values above \code{p = 1} will return \code{NA}.
|
|
}
|
|
\details{
|
|
\strong{NOTE}: this function will be moved to the \code{cleaner} package when a new version is being published on CRAN.
|
|
}
|
|
\section{Questioning lifecycle}{
|
|
|
|
\if{html}{\figure{lifecycle_questioning.svg}{options: style=margin-bottom:5px} \cr}
|
|
The \link[=lifecycle]{lifecycle} of this function is \strong{questioning}. This function might be no longer be optimal approach, or is it questionable whether this function should be in this \code{AMR} package at all.
|
|
}
|
|
|
|
\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} (which reads a lot easier than here in R) 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}!
|
|
}
|
|
|