Skip to content

Commit 5c31c6e

Browse files
committed
update readme - ready to tag a test release 0.8.1 for R 3.5.x
1 parent fbcdeba commit 5c31c6e

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1-
rClr
2-
====
1+
# rClr
32

4-
R package for accessing .NET
3+
## R package for accessing .NET
54

65
The latest is on the [testing branch](https://github.com/jmp75/rClr/tree/testing). As of March 2019 testing support for R 3.5.
76

87
Accessing the Common Language Runtime (.NET or Mono) from the R statistical software, in-process.
98

10-
# Installing
9+
## Installing
1110

1211
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).
1312

14-
## Pre-compiled binaries
13+
### Pre-compiled binaries
1514

1615
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')`
1716

18-
## From source
17+
### From source
18+
19+
#### Windows
20+
21+
Under construction as of 2019-04:
1922

2023
```bat
2124
REM important to not have nuget.exe under c:\bin
@@ -27,6 +30,8 @@ echo %R_EXE%
2730
%R_EXE% CMD INSTALL rClr_0.8.tar.gz
2831
```
2932

33+
#### Windows
34+
3035
Installing on Linux is always installing from source anyway, be it from a tarball, cloning the repo, or using `devtools`.
3136

3237
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
3843
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.
3944

4045
```R
41-
# Optionally you may remove a prior package
46+
## Optionally you may remove a prior package
4247
remove.packages('rClr')
4348
library(devtools)
4449
install_github("jmp75/rClr", build_vignettes=TRUE)
4550
```
4651

4752
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.
4853

49-
# Getting started
54+
## Getting started
5055

5156
The package contains documentation, code sample and a vignette to get started.
5257

5358
```S
5459
library(rClr)
5560
?rClr
56-
# There is an HTML vignette:
61+
## There is an HTML vignette:
5762
browseVignettes('rClr')
5863
```
5964

6065
You will otherwise find some documentation at [https://r2clr.codeplex.com/documentation](https://r2clr.codeplex.com/documentation)
6166

62-
# Feedback and contributions
67+
## Feedback and contributions
6368

6469
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.
6570

6671
* 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.
6772
* Documentation: reporting issues, feature requests or discussion threads as such can be very valuable material if done well.
6873
* Consulting or contract work is an option that may be arranged.
6974

70-
# Related work
75+
## Related work
7176

7277
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.
7378

0 commit comments

Comments
 (0)