Access R packages from F#
Clone or download
zyzhu Merge pull request #201 from zyzhu/fix-misc
Fix RProvider.fsx and Release Notes
Latest commit e01f70e Sep 17, 2018
Permalink
Failed to load latest commit information.
.paket fix build on latest visual studio. updated documentations links to fslab Jul 11, 2018
.vs fix build on latest visual studio. updated documentations links to fslab Jul 11, 2018
docs Merge pull request #197 from zyzhu/netstandard Jul 19, 2018
nuget updated release notes and nuspec for 1.1.21 release Sep 17, 2018
src updated release notes and nuspec for 1.1.21 release Sep 17, 2018
tests/Test.RProvider update packages Jul 18, 2018
tools/ILRepack Address paket-files, FSharp.Core and NuGet commands Jan 13, 2015
.gitattributes Initial version Jul 26, 2012
.gitignore fix build on latest visual studio. updated documentations links to fslab Jul 11, 2018
.travis.yml build on travis Jul 18, 2018
LICENSE.md Include RDotNet binaries, as I have now verified that this is allowed… Jul 27, 2012
README.md fix build on latest visual studio. updated documentations links to fslab Jul 11, 2018
RELEASE_NOTES.md updated release notes and nuspec for 1.1.21 release Sep 17, 2018
RProvider.Tests.sln Update R provider to use Paket & try fix Travis Jan 13, 2015
RProvider.sln Finish Paket conversion improvements Jan 13, 2015
build.cmd Fix build.cmd to use paket Jun 8, 2015
build.fsx fix build on latest visual studio. updated documentations links to fslab Jul 11, 2018
build.sh Update R provider to use Paket & try fix Travis Jan 13, 2015
paket.dependencies bring some packages up-to-date Jul 18, 2018
paket.lock bring some packages up-to-date Jul 18, 2018

README.md

F# R Provider Build Status

RProvider logo

An F# type provider for interoperating with R. For more information, see detailed documentation with tutorials, examples and more. The following tutorials are a good place to start:

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 Visual Studio, Xamaring Studio and other IDEs, 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 documentation page

License

RProvider 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, downloadable from here.

On Windows, 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.

On Mac and Linux, you need to install 64 bit version of Mono, setup Xamarin Studio to run F# Interactive in 64 bit and create a configuration file ~/.rprovider.conf to tell the R provider how to start its server process in 64 bit mode. For detailed documentation see the R provider Mac/Linux page.

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.