describeProp: A function that returns a description proportion that...

Description Usage Arguments Value See Also Examples

Description

A function that returns a description proportion that contains the number and the percentage

Usage

1
2
3
describeProp(x, html = TRUE, digits = 1, number_first = TRUE,
  useNA = c("ifany", "no", "always"), useNA.digits = digits, default_ref,
  percentage_sign = TRUE, language = "en", ...)

Arguments

x

The variable that you want the statistics for

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.

default_ref

The default reference, either first, the level name or a number within the levels. If left out it defaults to the first value.

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

See Also

Other descriptive functions: describeFactors, describeMean, describeMedian, getDescriptionStatsBy, getPvalWilcox

Examples

1
describeProp(factor(sample(50, x=c("A","B", NA), replace=TRUE)))


Search within the Gmisc package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.