Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tpetricek committed Jan 14, 2015
1 parent 8795656 commit 9703840
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,13 @@ 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.
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](https://nuget.org/packages/RProvider/). Many thanks to Mathias Brandewinder for producing the [FAKE](https://github.com/fsharp/FAKE) script to build the NuGet package, and to Steffen Forkmann for writing [FAKE](https://github.com/fsharp/FAKE).

There is a lot of info on how to use the provider on our [how to page](https://github.com/BlueMountainCapital/FSharpRProvider/wiki/How-To).

For other information, check out the other pages on the [wiki](https://github.com/BlueMountainCapital/FSharpRProvider/wiki).
There is a lot of info on how to use the provider on our [documentation page](http://bluemountaincapital.github.io/FSharpRProvider/)

License
=======
Expand All @@ -38,7 +36,11 @@ The library uses [RDotNet](http://rdotnet.codeplex.com/) which is also covered b

Pre-requisites
==============
The R Provider requires an installation of R for Windows, downloadable from [here](http://cran.cnr.berkeley.edu/bin/windows/base/). 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.
The R Provider requires an installation of R, downloadable from [here](http://cran.r-project.org/).

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](http://bluemountaincapital.github.io/FSharpRProvider/mac-and-linux.html).

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.

Expand Down

0 comments on commit 9703840

Please sign in to comment.