Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/senseyeio/roger
Golang RServe client. Use R from Go
https://github.com/senseyeio/roger
data-science go r rserve scientific-computing
Last synced: 3 months ago
JSON representation
Golang RServe client. Use R from Go
- Host: GitHub
- URL: https://github.com/senseyeio/roger
- Owner: senseyeio
- License: mit
- Created: 2015-08-10T21:10:15.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-10-09T21:10:45.000Z (about 5 years ago)
- Last Synced: 2024-06-18T21:29:25.657Z (5 months ago)
- Topics: data-science, go, r, rserve, scientific-computing
- Language: Go
- Homepage:
- Size: 84 KB
- Stars: 272
- Watchers: 28
- Forks: 34
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-golang-repositories - roger
README
# Roger
[](https://godoc.org/github.com/senseyeio/roger)
[](https://travis-ci.org/senseyeio/roger)
[](https://gitter.im/senseyeio/roger?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Roger is a Go [RServe](http://www.rforge.net/Rserve/) client, allowing the capabilities of [R](http://www.r-project.org/) to be used from Go applications.
The communication between Go and R is via TCP. It is thread safe and supports long running R operations synchronously or asynchronously (using channels).
```go
package main
import (
"fmt"
"github.com/senseyeio/roger"
)
func main() {
rClient, err := roger.NewRClient("127.0.0.1", 6311)
if err != nil {
fmt.Println("Failed to connect")
return
}
value, err := rClient.Eval("pi")
if err != nil {
fmt.Println("Command failed: " + err.Error())
} else {
fmt.Println(value) // 3.141592653589793
}
helloWorld, _ := rClient.Eval("as.character('Hello World')")
fmt.Println(helloWorld) // Hello World
arrChan := rClient.Evaluate("Sys.sleep(5); c(1,1)")
arrResponse := <-arrChan
arr, _ := arrResponse.GetResultObject()
fmt.Println(arr) // [1, 1]
}
```
### Response Type Support
Roger currently supports the following response types from R:
- string and string arrays
- booleans and boolean arrays
- doubles and double arrays
- ints and int arrays
- complex and complex arrays
- lists
- raw byte arrays
With the use of JSON, this capability can be used to transfer any serializable object. For examples see sexp_parsing_test.go.
### Assignment Support
Roger allows variables to be defined within an R session from Go. Currently the following types are supported for variable assignment:
- string and string arrays
- byte arrays
- doubles and double arrays
- ints and int arrays
For examples see assignment_test.go.
## Setup
Rserve should be installed and started from R:
```R
install.packages("Rserve")
require('Rserve')
Rserve()
```
More information is available on [RServe's website](https://www.rforge.net/Rserve/doc.html).
If you would like to exploit the current R environment from go, start RServe using the following command:
```R
install.packages("Rserve")
require('Rserve')
run.Rserve()
```
Install Roger using:
```
go get github.com/senseyeio/roger
```
## Testing
To ensure the library functions correctly, the end to end functionality must be tested. This is achieved using [Docker](https://docs.docker.com) and [Docker Compose](https://docs.docker.com/compose). To run tests, ensure you have both Docker and Docker Compose installed, then run `docker-compose build && docker-compose up -d` from within the test directory. This command will build and start a docker container containing multiple RServe servers. These servers will be utilized when running `go test` from the project's base directory. To stop the docker container call `docker-compose stop` from the test directory.
## Contributing
Issues, pull requests and questions are welcomed. If required, assistance can be found in the project's [gitter chat room](https://gitter.im/senseyeio/roger).
### Pull Requests
- Fork the repository
- Make changes
- Ensure tests pass
- Raise pull request