tidyPop: Tidying Simcyp simulator population names for reports, etc.

View source: R/tidyPop.R

tidyPopR Documentation

Tidying Simcyp simulator population names for reports, etc.

Description

tidyPop

Usage

tidyPop(input_pop, dialect = "British", output_type = "all")

Arguments

input_pop

input population to tidy up; this has been designed to work with extractExpDetails with the output item named "Population"

dialect

Use "British" (default) or "American" spelling when there's a difference. Currently only affects "paediatric" vs. "pediatric" populations.

output_type

Which outputs do you want? Options:

"Population"

the population, prettified

"PopulationSimple"

the prettified and simplified version of the population. For example, "Healthy Volunteers" would become "healthy subjects" and "Cirrhosis CP-A" would become "patients".

"Population1stCap"

the prettified population with the first letter capitalized, e.g., for use at the beginning of a sentence

"PopulationCap"

the population with title-case capitalization

"PopulationSimpleLower"

the lower-case version of the simplified population, e.g., "subjects" or "patients"

"PopulationSimpleCap"

the simplified population but capitalized

"all" (default)

a list of all of the above

Value

a tidied set of names for a simulated population

Examples

# No examples yet

shirewoman2/Consultancy documentation built on Feb. 18, 2025, 10 p.m.