typewriter/README.Rmd at main · eoda-dev/typewriter · GitHub

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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# typewriter

<!-- badges: start -->
[![R-CMD-check](https://github.com/eoda-dev/typewriter/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/eoda-dev/typewriter/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of typewriter is to add type safety to your R code.

## Installation

You can install the development version of typewriter from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("eoda-dev/typewriter")
```

## Examples

```{r example}
library(typewriter)

# Functions
f <- function(a = "integer", b = "integer:1") {
  check_args()
  a + b
}

f(5L, 3L)
try(f(5L, c(3L, 4L)))

# Data frames
df <- data.frame(
  id = 1:3,
  letter = letters[1:3]
)

my_model <- base_model(
  id = "integer",
  letter = "character"
)

model_validate(df, my_model)

df$id <- as.double(df$id)
try(model_validate(df, my_model))

# Typed structs
my_type <- typed_struct(
  a = "integer",
  b = "integer"
)

(mt <- my_type(a = 2L, b = 4L))

class(mt)

try(mt$a <- 10.5)

try(my_type(a = 2L, b = 4.5))
```