R Graphical Manual

Browse All

Last data update: 2014.03.03

R: A function that returns a description median that contains...

describeMedian

R Documentation

A function that returns a description median that contains the interquartile range or the full range

Description

A function that returns a description median that contains the interquartile range or the full range

Usage

describeMedian(x, iqr = TRUE, html = TRUE, digits = 1,
  number_first = TRUE, useNA = c("ifany", "no", "always"),
  useNA.digits = digits, percentage_sign = TRUE, language = "en", ...)

Arguments

`x`	The variable that you want the statistics for
`iqr`	If interquartile range should be used
`html`	If HTML compatible output should be used. If `FALSE` it outputs LaTeX formatting
`digits`	The number of decimals used
`number_first`	If the number should be given or if the percentage should be presented first. The second is encapsulated in parentheses (). This is only used together with the useNA variable.
`useNA`	This indicates if missing should be added as a separate row below all other. See `table` for `useNA`-options. Note: defaults to ifany and not "no" as `table` does.
`useNA.digits`	The number of digits to use for the missing percentage, defaults to the overall `digits`.
`percentage_sign`	If you want to suppress the percentage sign you can set this variable to FALSE. You can also choose something else that the default % if you so wish by setting this variable. Note, this is only used when combined with the missing information.
`language`	The ISO-639-1 two-letter code for the language of interest. Currently only english is distinguished from the ISO format using a ',' as the separator in the `txtInt` function.
`...`	Passed on to `describeFactors`

Value

string A string formatted for either LaTeX or HTML

Examples

describeMedian(1:10)
describeMedian(c(1:10, NA), useNA="ifany")

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(Gmisc)
Loading required package: Rcpp
Loading required package: htmlTable
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/Gmisc/describeMedian.Rd_%03d_medium.png", width=480, height=480)
> ### Name: describeMedian
> ### Title: A function that returns a description median that contains the
> ###   interquartile range or the full range
> ### Aliases: describeMedian
> 
> ### ** Examples
> 
> describeMedian(1:10)
     Median (IQR) 
"5.5 (3.2 - 7.8)" 
> describeMedian(c(1:10, NA), useNA="ifany")
             TRUE             
Median (IQR) "5.5 (3.2 - 7.8)"
Missing      "1 (9.1%)"       
> 
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>

A function that returns a description median that contains the interquartile range or the full range

Description

Usage

Arguments

Value

See Also

Examples

Results