File: format_df_adjust.Rd

package info (click to toggle)
r-cran-parameters 0.24.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,852 kB
  • sloc: sh: 16; makefile: 2
file content (30 lines) | stat: -rw-r--r-- 743 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/format_df_adjust.R
\name{format_df_adjust}
\alias{format_df_adjust}
\title{Format the name of the degrees-of-freedom adjustment methods}
\usage{
format_df_adjust(
  method,
  approx_string = "-approximated",
  dof_string = " degrees of freedom"
)
}
\arguments{
\item{method}{Name of the method.}

\item{approx_string, dof_string}{Suffix added to the name of the method in
the returned string.}
}
\value{
A formatted string.
}
\description{
Format the name of the degrees-of-freedom adjustment methods.
}
\examples{
library(parameters)

format_df_adjust("kenward")
format_df_adjust("kenward", approx_string = "", dof_string = " DoF")
}