Skip to content
This repository

An F# Type Provider to interop with R

branch: master
README.md

logo

F# R Provider

An F# type provider for interoperating with R.

What does it do?

The R Provider discovers R packages that are available in your R installation and makes them available as .NET namespaces underneath the parent namespace RProvider. For example, the stats package is available as RProvider.stats. If you open the namespaces you want to use, functions and values will be available as R.name. For example, consider this F# interactive script:

#r "RProvider.dll"

open RProvider
open RProvider.``base``

let v = R.c(1,2,3)

This creates an R numeric vector containing 1,2,3, and names it v. Note that we had to open the base namespace, since the function 'c' is part of that namespace. You should also open namespace RProvider, because it contains some helper functions.

And because type providers are used by the Visual Studio IDE, you will get intellisense for R functions. You will also get compile-time type-checking that the function exists.

How to use it

Install using the NuGet package. Many thanks to Mathias Brandewinder for producing the FAKE script to build the NuGet package, and to Steffen Forkmann for writing FAKE.

There is a lot of info on how to use the provider on our how to page.

For other information, check out the other pages on the wiki.

License

FSharpRProvider is covered by the BSD license.

The library uses RDotNet which is also covered by the BSD license.

Pre-requisites

The R Provider requires an installation of R for Windows, downloadable from here. RProvider uses the R registry key SOFTWARE\R-core to locate the R binary directory, in order to load R.dll. It will also locate R.dll if it is on the path. If run from a 32-bit process, RProvider will use the 32-bit R.DLL, and if run from a 64-bit process, it will load the 64-bit version.

If you are using R 2.15 or later, you should not try to load the RProvider inside a script that is passed to FSI via the --use flag. It seems that something about the way R initializes causes it to hang in that context. Works fine if you load later.

For compilation you will need VS2012 / F# 3.0 or later. For runtime you'll need .NET 4.5.

Something went wrong with that request. Please try again.