You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-11Lines changed: 16 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,24 @@
1
-
rClr
2
-
====
1
+
# rClr
3
2
4
-
R package for accessing .NET
3
+
## R package for accessing .NET
5
4
6
5
The latest is on the [testing branch](https://github.com/jmp75/rClr/tree/testing). As of March 2019 testing support for R 3.5.
7
6
8
7
Accessing the Common Language Runtime (.NET or Mono) from the R statistical software, in-process.
9
8
10
-
# Installing
9
+
##Installing
11
10
12
11
As of September 2015, the source code snapshot of tagged releases can be found via the [release tab of the rClr GitHub repository](https://github.com/jmp75/rClr/releases). Binary R packages for Windows cannot be released via github, and you can get them from [https://rclr.codeplex.com](https://rclr.codeplex.com).
13
12
14
-
## Pre-compiled binaries
13
+
###Pre-compiled binaries
15
14
16
15
You can install pre-compiled rClr for Windows via [https://rclr.codeplex.com](https://rclr.codeplex.com). You can use from the command line `R CMD INSTALL rclr_0.8.zip` where `R` points to one of the R.exe installed on your machine, or from R itself `install.packages('c:/path/to/rclr_0.8.zip')`
17
16
18
-
## From source
17
+
### From source
18
+
19
+
#### Windows
20
+
21
+
Under construction as of 2019-04:
19
22
20
23
```bat
21
24
REM important to not have nuget.exe under c:\bin
@@ -27,6 +30,8 @@ echo %R_EXE%
27
30
%R_EXE% CMD INSTALL rClr_0.8.tar.gz
28
31
```
29
32
33
+
#### Windows
34
+
30
35
Installing on Linux is always installing from source anyway, be it from a tarball, cloning the repo, or using `devtools`.
31
36
32
37
rClr is not your average R package and requires a few more tools than is typical for most R packages.
@@ -38,36 +43,36 @@ A Linux distribution with R, g++ and the Mono toolchain (including xbuild) shoul
38
43
You should be able to install the package using the `install_github` function of the package `devtools`. The following commands have been tested successfully on Windows with VS2013 and Linux with Mono 3.10, on 2014-12-19.
NOTE: you must have a fully working devtools package. If devtools, on loading, reports a warning about not finding a suitable version of RTools (on Windows), this may prevent it from installing rClr. The issue has been seen for instance using devtools 1.7.0, installed from CRAN, via R 3.2.2. Package devtools 1.7.0 seems to require RTools 3.1, even when run from R 3.2.2. One way to overcome this is to install devtools from a more recent download, from its github repository.
48
53
49
-
# Getting started
54
+
##Getting started
50
55
51
56
The package contains documentation, code sample and a vignette to get started.
52
57
53
58
```S
54
59
library(rClr)
55
60
?rClr
56
-
# There is an HTML vignette:
61
+
## There is an HTML vignette:
57
62
browseVignettes('rClr')
58
63
```
59
64
60
65
You will otherwise find some documentation at [https://r2clr.codeplex.com/documentation](https://r2clr.codeplex.com/documentation)
61
66
62
-
# Feedback and contributions
67
+
##Feedback and contributions
63
68
64
69
While this package is sometimes used for the author's paid day job, this is largely a personal endeavour. Support is appreciated in many forms.
65
70
66
71
* Citations: As of December 2014, [A presentation given at the R user conference 2013](https://publications.csiro.au/rpr/pub?list=ASE&pid=csiro:EP132284&expert=false&sb=RECENT&n=6&rpp=50&page=17&tr=3274&dr=all&csiro.affiliation=B3800). A journal paper will, hmm, "soon" follow.
67
72
* Documentation: reporting issues, feature requests or discussion threads as such can be very valuable material if done well.
68
73
* Consulting or contract work is an option that may be arranged.
69
74
70
-
# Related work
75
+
##Related work
71
76
72
77
A few packages using rClr are publicly accessible, and may be of interest if you want to build your own package with dependencies on rClr.
0 commit comments