Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/renkun-ken/rtype
A strong type system for R
https://github.com/renkun-ken/rtype
Last synced: 11 days ago
JSON representation
A strong type system for R
- Host: GitHub
- URL: https://github.com/renkun-ken/rtype
- Owner: renkun-ken
- License: other
- Created: 2014-07-30T04:04:30.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-08-15T14:25:03.000Z (about 10 years ago)
- Last Synced: 2024-10-19T05:59:13.049Z (20 days ago)
- Language: R
- Homepage: renkun.me/rtype
- Size: 328 KB
- Stars: 33
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - renkun-ken/rtype - A strong type system for R (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')
rm(list = objects())
```
# rtype
[](https://travis-ci.org/renkun-ken/rtype)
rtype is a strong type system for R which supports symbol declaration and assignment with type checking.
[Release notes](https://github.com/renkun-ken/rtype/releases)
## Installation
You can install the latest released version from [CRAN](http://cran.r-project.org/web/packages/rtype/) with
```r
install.packages("rtype")
```
or the latest development version from GitHub with
```r
devtools::install_github("rtype","renkun-ken")
```
## Examples
### Declaring symbols
Declare symbols Before using them.
```{r}
library(rtype)
declare(x,y=numeric(),z=logical())
ls.str()
```
### Assignment with type checking
```{r}
# NULL symbol can be assigned any value
numeric(x) <- c(1,2,3.5)
# numeric symbol can be assigned only numeric value
# is.numeric(y) = TRUE, and is.numeric(c(1,2,3)) = TRUE
numeric(y) <- c(1,2,3)
# the symbol does not take value that violates its type checking
# is.integer(y) = FALSE (violation)
integer(y) <- c(1L,2L)
# the assignment fails if the value does not pass type checking
# is.logical(z) = TRUE, but is.logical(c(1,2,3)) = FALSE (violation)
logical(z) <- c(1,2,3)
```
### Assignment with condition checking
Checking single condition
```{r}
# assign value checking condition length = 3
numeric(x, length = 3) <- c(1,2,3)
# stop if condition is violated
numeric(x, length = 3) <- c(1,2,3,4)
```
Checking multiple conditions
```{r}
# assign value checking multiple conditions
declare(df)
data.frame(df, ncol=2, nrow=10) <- data.frame(x=1:10,y=letters[1:10])
# or equivalently
data.frame(df, dim=c(10,2)) <- data.frame(x=1:10,y=letters[1:10])
# stop if any condition is violated
data.frame(df, ncol=3, nrow=10) <- data.frame(x=1:10,y=letters[1:10])
```
Checking function conditions
```{r}
# checking function condition
declare(x)
cond1 <- function(x) mean(x) <= 5
numeric(x, length = 10, cond1) <- 0:9
numeric(x, length = 10, cond1) <- 1:10
```
General checking
```{r}
declare(x)
check(x, class="integer", length=10) <- 1:10
check(x, class="numeric", length=10) <- 1:10
```
## Help overview
```r
help(package = rtype)
```
## License
This package is under [MIT License](http://opensource.org/licenses/MIT).