rprintf: Build a character vector or list with adaptive string...

Description Usage Arguments Examples

View source: R/rprintf.R

Description

The rprintf function checks the given character vector or list and applies appropriate formatters that transform it from generic patterns to specific texts with variables and indices as placeholders replaced by a given set of values in correct formats.

Usage

1
rprintf(.format, ..., .envir = parent.frame())

Arguments

.format

The character vector or list to be transformed

...

The arguments that specify the set of values to be placed

.envir

The environment in which variables are searched if not explictly specified. Use emptyenv() to disable this behavior. This feature only works for variable-name formatting.

Examples

 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
31
32
33
34
35
## Not run: 
#' # Format a single-entry character vector with sprintf mechanism
rprintf('Hello, %s','world')
rprintf('%s (%d years old)','Ken',24)
rprintf('He is %d but has a height of %.1fcm',18,190)

# Format a single-entry character vector with variable mechanism
rprintf('Hello, $name', name='world')
rprintf('$name ($age years old)',name='Ken',age=24)
rprintf('He is $age but has a height of $height:.2fcm',age=18,height=190)
rprintf('$a, $b:.1f, $c:+.2f, $b, $a:.0f',a=1.56,b=2.34,c=3.78)

# Format a single-entry character vector with numbering mechanism
rprintf('Hello, {1}', 'world')
rprintf('{1} ({2} years old)','Ken',24)
rprintf('He is {1} but has a height of {2:.2f}cm',18,190)
rprintf('{1}, {2:.1f}, {3:+.2f}, {2}, {1:.0f}',1.56,2.34,3.78)
rprintf('{2},{1}','x','y')

# This function also works for character vectors and lists.
rprintf(c('%s:%d','$name:$age','{1}:{2}'),name='Ken',age=24)
rprintf(c(a='%s:%d',b='$name:$age',c='{1}:{2}'),name='Ken',age=24)
rprintf(list('%s:%d','$name:$age','{1}:{2}'),name='Ken',age=24)
rprintf(list(a='%s:%d',b='$name:$age',c='{1}:{2}'),name='Ken',age=24)

# It also works with list argument for named variables.
p <- list(name='Ken',age=24)
rprintf('name: $name, age: $age',p)
rprintf('name: {1}, age: {2}',p)

Note that when the list of arguments are given names,
the variable names in format string should be modified.
rprintf('name: $arg.name, age: $arg.age', arg = p)

## End(Not run)

renkun-ken/rprintf documentation built on May 27, 2019, 5:50 a.m.