Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ARROW-1325: [R] Initial R package that builds against the arrow C++ library #2489

Closed
wants to merge 6 commits into from
Closed

ARROW-1325: [R] Initial R package that builds against the arrow C++ library #2489

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2848fd1
initial R :package: with travis setup and testthat suite, that links …
romainfrancois Aug 28, 2018
fb412ca
not checking for headers on these files
romainfrancois Aug 28, 2018
a1a5e7c
+ installation instructions
romainfrancois Aug 28, 2018
79c5001
follow up from @wesm comments on #2489
romainfrancois Sep 7, 2018
9e3ffb4
skip using rpath linker option
romainfrancois Sep 7, 2018
89f14b4
Add license addendums
wesm Sep 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
+ installation instructions
  • Loading branch information
@romainfrancois
romainfrancois committed Sep 6, 2018
commit a1a5e7c336148593b4686f5311a0f98cb10ea967
2 changes: 2 additions & 0 deletions dev/release/rat_exclude_files.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,3 +123,5 @@ r/LICENSE.md
r/NAMESPACE
r/.Rbuildignore
r/arrow.Rproj
r/README.md
r/README.Rmd
1 change: 1 addition & 0 deletions r/.Rbuildignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
^.*\.Rproj$
^\.Rproj\.user$
^README\.Rmd$
40 changes: 40 additions & 0 deletions r/README.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# arrow

Low level bindings to the C++ Apache Arrow library

## Installation

First install a release build of the C++ bindings to arrow.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it have to be a release build?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure, I just stole this from @jimhester. I guess it could be other types of builds as long as pkg-config finds the relevant information in the ./configure script


```shell
git clone https://github.com/apache/arrow.git
cd arrow/cpp && mkdir release && cd release

# It is important to statically link to boost libraries
cmake .. -DCMAKE_BUILD_TYPE=Release -DARROW_BOOST_USE_SHARED:BOOL=Off
make install
```

Then the R package:

```r
devtools::install_github("apache/arrow/r")
```

## Example

(not yet)
29 changes: 29 additions & 0 deletions r/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# arrow

Low level bindings to the C++ Apache Arrow library
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe "R interface to the ..." or "R integration with...", since the extent of the work involved is a bit more than bindings

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. Made it R integration with Apache Arrow. for now, we can always revisit this later when we can better define what this is.


## Installation

First install a release build of the C++ bindings to arrow.

``` shell
git clone https://github.com/apache/arrow.git
cd arrow/cpp && mkdir release && cd release

# It is important to statically link to boost libraries
cmake .. -DCMAKE_BUILD_TYPE=Release -DARROW_BOOST_USE_SHARED:BOOL=Off
make install
```

Then the R package:

``` r
devtools::install_github("apache/arrow/r")
```

## Example

(not yet)