# optiRum v0.40.1

0

Monthly downloads

## Financial Functions & More

This fills the gaps credit analysts and loan modellers at
Optimum Credit identify in the existing R code body.
It allows for the production of documentation with less coding,
replicates a number of Microsoft Excel functions useful for
modelling loans (without rounding), and other helpful functions
for producing charts and tables. It also has some additional scales for
use, including a GBP scale.

## Functions in optiRum

Name | Description | |

theme_optimum | Produce an Optimum-standard base chart | |

thousands_format | Thousands formatter: format number with commas separating the number thousands and suffixed with a k. | |

wordwrap | Produce a string with one word per line | |

scaledScore | Produce a scaled score based on a logit | |

taxYear | Returns the UK financial tax year for a given date | |

odd.logit | Convert an odd into a logit | |

giniChart | Produce a ROC curve with gini coefficient title | |

APR | Calculates the compound interest rate for a loan | |

CJ.dt | Cross join two data.tables | |

PMT | Calculates the repayment for a loan | |

RATE | Calculates compounded interest rate | |

generatePDF | Convert an .Rnw file to a PDF | |

calcNetIncome | Calculate income after tax and benefits | |

convertToXML | Produce an XML document of a table | |

PV | Calculates the present value | |

pounds_format | Currency formatter: round to nearest penny and display pounds sign. | |

logit.odd | Convert a logit to odds | |

prob.odd | Convert a probability into odds probability | |

multiplot | Multiple plot function | |

sanitise | A cleaning function for special characters | |

optiRum | optiRum is a helper package | |

giniCoef | Produce a gini coefficient | |

logit.prob | Convert a logit to probability | |

odd.prob | Convert an odds to probability | |

prob.logit | Convert a probability into a logit | |

No Results! |

## Vignettes of optiRum

Name | ||

index.Rmd | ||

presentation.Rmd | ||

No Results! |

## Last month downloads

## Details

Encoding | UTF-8 |

License | GPL-3 |

LazyData | true |

URL | https://github.com/lockedata/optiRum, https://itsalocke.com/optirum/ |

BugReports | https://github.com/lockedata/optiRum/issues |

VignetteBuilder | knitr |

RoxygenNote | 6.0.1.9000 |

NeedsCompilation | no |

Packaged | 2018-07-03 17:50:06 UTC; Maelle |

Repository | CRAN |

Date/Publication | 2018-07-03 19:30:06 UTC |

imports | AUC , data.table (>= 1.9.6) , ggplot2 , grid , knitr , plyr , scales , stringr , XML |

suggests | covr , rmarkdown , testthat |

depends | R (>= 3.0.2) |

Contributors | Ma<c3><ab>lle Salmon, Locke Data , Optimum Credit Ltd's analysts |

#### Include our badge in your README

```
[![Rdoc](http://www.rdocumentation.org/badges/version/optiRum)](http://www.rdocumentation.org/packages/optiRum)
```