Skip to main content

Getting started

Installation​

For RStudio​

You can check the typr.runner package to install it directly on RStudio.

with Docker​

You can visit it's repository here.

To download the image, just use:

docker pull fabricehategekimana/typr:latest

You can run it with:

docker run -it --rm -v $(pwd):/workspace fabricehategekimana/typr:latest

From Scratch​

To install TypR, you will need to install Rust (of course you should have R installed in your system):

After that, you just need to install the cli typr (the transpiler) with cargo (installed with Rust):

cargo install typr

And you're good to go.

Usage​

Actually, the executable of TypR can:

  • Type check the code
  • Generate the target code (mainly R actually)
  • Work project folders

You can see all the faculties of the CLI with the help option:

typr --help

The prefered file extension is .ty. It has not it's own syntax highliter yet but I recommend you to use the one from Scala. For instance, if you want to execute a file named app.ty, you just need this command:

typr app.ty

Basic documentation​

Roadmap​

This project needs more refinement and the documentation will evolve throug it's iterations. Mainly, I am trying to reach thos goals:

  • Update the documentation
  • Dedicated WebSite
  • Finish the type embedding's implementation
  • Better interface inference
  • Label Generics
  • Vectorial blocs
  • Finish Typescript/Javascript implementation
  • JS blocs
  • Finish WASM implementation

Support this project​

If you find this project useful or interesting, there are several ways you can support it:

  • Contribute by improving the code, reporting issues, or suggesting features
  • Donate via Patreon to help sustain development
  • Share the project with others who might benefit from it

Every contribution, no matter how small, helps this project grow. Thank you!