Skip to content

Commit

Permalink
Better readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
dereckmezquita committed Jul 29, 2024
1 parent 855de6d commit c935dfe
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
9 changes: 8 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,14 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h
status](https://travis-ci.org/dereckmezquita/kucoin.svg?branch=master)](https://travis-ci.org/dereckmezquita/kucoin)
<!-- badges: end -->

The `interface` package provides a system for defining and implementing interfaces in R, with runtime type checking, bringing some of the benefits of statically-typed languages to R.
The `interface` package provides a system for defining and implementing interfaces in R, with runtime type checking, bringing some of the benefits of statically-typed languages to R with zero dependencies.

`interface` provides:

1. **Interfaces**: Define and implement interfaces with type checking. Interfaces can be extended and nested.
1. **Typed Functions**: Define functions with strict type constraints.
1. **Typed Frames**: Choose between a `data.frame` or `data.table` with column type constraints and row validation.
1. **Enums**: Define and use enumerated types for stricter type safety.

## Installation

Expand Down
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,16 @@ status](https://travis-ci.org/dereckmezquita/kucoin.svg?branch=master)](https://

The `interface` package provides a system for defining and implementing
interfaces in R, with runtime type checking, bringing some of the
benefits of statically-typed languages to R.
benefits of statically-typed languages to R with zero dependencies.

`interface` provides:

1. **Interfaces**: Define and implement interfaces with type checking.
Interfaces can be extended and nested.
2. **Typed Functions**: Define functions with strict type constraints.
3. **Typed Frames**: Choose between a `data.frame` or `data.table` with
column type constraints and row validation.
4. **Enums**: Define and use enumerated types for stricter type safety.

## Installation

Expand Down Expand Up @@ -121,7 +130,7 @@ print(john_student)
#> scores: Science
#> scores: 95
#> scores: 88
#> scholarship: <environment: 0x116831678>
#> scholarship: <environment: 0x1175a13b8>
#> street: 123 Main St
#> city: Small town
#> postal_code: 12345
Expand Down

0 comments on commit c935dfe

Please sign in to comment.