https://github.com/renkun-ken/rprintf

Adaptive builder for formatted strings
https://github.com/renkun-ken/rprintf

Last synced: about 1 month ago
JSON representation

Adaptive builder for formatted strings

• Host: GitHub
• URL: https://github.com/renkun-ken/rprintf
• Owner: renkun-ken
• License: other
• Created: 2014-05-30T15:08:10.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-10-30T06:08:00.000Z (about 9 years ago)
• Last Synced: 2024-04-25T08:44:09.590Z (8 months ago)
• Language: R
• Homepage:
• Size: 337 KB
• Stars: 17
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - renkun-ken/rprintf - Adaptive builder for formatted strings (R)

README

        
```{r knitsetup, echo=FALSE, results='hide', warning=FALSE, message=FALSE, cache=FALSE}

library(knitr)

opts_knit$set(base.dir = './', fig.path = '', out.format = 'md')

opts_chunk$set(prompt = FALSE, comment = '', results = 'markup')

```

# rprintf

[![Linux Build Status](https://travis-ci.org/renkun-ken/rprintf.png?branch=master)](https://travis-ci.org/renkun-ken/rprintf) 

[![Windows Build status](https://ci.appveyor.com/api/projects/status/github/renkun-ken/rprintf?svg=true)](https://ci.appveyor.com/project/renkun-ken/rprintf)

[![codecov.io](http://codecov.io/github/renkun-ken/rprintf/coverage.svg?branch=master)](http://codecov.io/github/renkun-ken/rprintf?branch=master)

[![CRAN Version](http://www.r-pkg.org/badges/version/rprintf)](http://cran.rstudio.com/web/packages/rprintf)

rprintf is an adaptive builder for formatted strings. Currently it provides a set of tools for building formatted strings under various replacement rules: 

- C-style formatting with `sprintf`

- Number-based formatting

- Variable-based formatting

The primary goal of this package is to make it easier to produce formatted strings in all popular styles.

## Installation

You can install from CRAN with

```r

install.packages("rprintf")

```

or you can install the latest development version from GitHub with

```r

devtools::install_github("rprintf","renkun-ken")

```

## Examples

The following examples demonstrate how `rprintf` functions works. You should be familiar with how `sprintf` works first. See the [documentation](http://stat.ethz.ch/R-manual/R-devel/library/base/html/sprintf.html) for more details.

### C-style formatting

```{r}

library(rprintf)

rprintf("Hello, %s", "world")

rprintf("%s (%d years old)", "Ken", 24)

rprintf("He is %d but has a height of %.1fcm", 18, 190)

```

### Number-based formatting

```{r}

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")

```

### Variable-based formatting

```{r}

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)

```

For each type of formatting, a specialized function is also provided. `rprintv` only handles named variable-based formatting, and `rprintn` only handles number-based formatting.

## License

This package is under [MIT License](http://opensource.org/licenses/MIT).