Skip to content

ARROW-13401 [R]: Update python.Rmd vignette#11914

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

Closed
AlenkaF wants to merge 9 commits into from
Closed

ARROW-13401 [R]: Update python.Rmd vignette #11914

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6d7c7af
"we" to "you"
AlenkaF Dec 9, 2021
2ae9429
Add link to the arrow vignette
AlenkaF Dec 9, 2021
c47a380
Add info about virtualenv
AlenkaF Dec 9, 2021
c931775
Make clear the package is pyarrow
AlenkaF Dec 9, 2021
b9b4dc4
Add a list of reasons to use pyarrow in R
AlenkaF Dec 9, 2021
433774f
Add How this works section
AlenkaF Dec 9, 2021
5424518
Apply suggestions from code review
AlenkaF Dec 9, 2021
9fdc08d
Update r/vignettes/python.Rmd
AlenkaF Dec 9, 2021
e5ac76e
Update r/vignettes/python.Rmd
AlenkaF Dec 9, 2021
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
39 changes: 30 additions & 9 deletions r/vignettes/python.Rmd
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,14 @@ vignette: >
%\VignetteEncoding{UTF-8}
---

The `arrow` package provides `reticulate` methods for passing data between
The arrow package provides [reticulate](https://rstudio.github.io/reticulate/) methods for passing data between
R and Python in the same process. This document provides a brief overview.

Why you might want to use `pyarrow`?

* To use some Python functionality that is not yet implemented in R, for example, the `concat_arrays` function.
* To transfer Python objects into R, for example, a Pandas dataframe into an R Arrow Array.

## Installing

To use `arrow` in Python, at a minimum you'll need the `pyarrow` library.
Expand All@@ -28,6 +33,11 @@ add `nightly = TRUE`:
install_pyarrow("arrow-env", nightly = TRUE)
```

A virtualenv or a virtual environment is a specific Python installation
created for one project or purpose. It is a good practice to use
specific environments in Python so that updating a package doesn't
impact packages in other projects.
Comment thread
AlenkaF marked this conversation as resolved.

`install_pyarrow()` also works with `conda` environments
(`conda_create()` instead of `virtualenv_create()`).

Expand All@@ -45,9 +55,9 @@ use_virtualenv("arrow-env")
pa <- import("pyarrow")
```

The package includes support for sharing Arrow `Array` and `RecordBatch`
The arrow R package include support for sharing Arrow `Array` and `RecordBatch`
objects in-process between R and Python. For example, let's create an `Array`
in `pyarrow`.
in pyarrow.

```r
a <- pa$array(c(1, 2, 3))
Expand All@@ -62,8 +72,8 @@ a
## ]
```

`a` is now an `Array` object in our R session, even though we created it in Python.
We can apply R methods on it:
`a` is now an `Array` object in your R session, even though you created it in Python.
You can apply R methods on it:

```r
a[a > 1]
Expand All@@ -76,10 +86,10 @@ a[a > 1]
## ]
```

We can send data both ways. One reason we might want to use `pyarrow` in R is
You can send data both ways. One reason you might want to use pyarrow in R is
to take advantage of functionality that is better supported in Python than in R.
For example, `pyarrow` has a `concat_arrays` function, but as of 0.17, this
function is not implemented in the `arrow` R package. We can use `reticulate`
For example, pyarrow has a `concat_arrays()` function, but as of 0.17, this
function is not implemented in the arrow R package. You can use reticulate
to use it efficiently.

```r
Expand All@@ -101,13 +111,24 @@ a_and_b
## ]
```

Now we have a single `Array` in R.
Now you have a single Array in R.

## How this works

"Send", however, isn't the correct word. Internally, we're passing pointers to
the data between the R and Python interpreters running together in the same
process, without copying anything. Nothing is being sent: we're sharing and
accessing the same internal Arrow memory buffers.

## Arrow object types

For more information about Arrow object types see the "Internals" section of
the "arrow" vignette:

```r
vignette("arrow", package = "arrow")
```

## Troubleshooting

If you get an error like
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
ARROW-13401 [R]: Update python.Rmd vignette by AlenkaF · Pull Request #11914 · apache/arrow · GitHub
Skip to content
ARROW-13401 [R]: Update python.Rmd vignette#11914

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

 Closed

AlenkaF
wants to merge
9
commits into

from

 Closed


ARROW-13401 [R]: Update python.Rmd vignette
#11914
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
6d7c7af

"we" to "you"


AlenkaF Dec 9, 2021
2ae9429

Add link to the arrow vignette


AlenkaF Dec 9, 2021
c47a380

Add info about virtualenv


AlenkaF Dec 9, 2021
c931775

Make clear the package is pyarrow


AlenkaF Dec 9, 2021
b9b4dc4

Add a list of reasons to use pyarrow in R


AlenkaF Dec 9, 2021
433774f

Add How this works section


AlenkaF Dec 9, 2021
5424518

Apply suggestions from code review


AlenkaF Dec 9, 2021
9fdc08d

Update r/vignettes/python.Rmd


AlenkaF Dec 9, 2021
e5ac76e

Update r/vignettes/python.Rmd


AlenkaF Dec 9, 2021

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


39 changes: 30 additions & 9 deletions
r/vignettes/python.Rmd

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,14 @@ vignette: >
 %\VignetteEncoding{UTF-8}
---

The `arrow` package provides `reticulate` methods for passing data between
The arrow package provides [reticulate](https://rstudio.github.io/reticulate/) methods for passing data between
R and Python in the same process. This document provides a brief overview.

Why you might want to use `pyarrow`?

* To use some Python functionality that is not yet implemented in R, for example, the `concat_arrays` function.
* To transfer Python objects into R, for example, a Pandas dataframe into an R Arrow Array. 

## Installing

To use `arrow` in Python, at a minimum you'll need the `pyarrow` library.
Expand All@@ -28,6 +33,11 @@ add `nightly = TRUE`:
install_pyarrow("arrow-env", nightly = TRUE)
```

A virtualenv or a virtual environment is a specific Python installation
created for one project or purpose. It is a good practice to use
specific environments in Python so that updating a package doesn't
impact packages in other projects.
Comment thread
AlenkaF marked this conversation as resolved.


`install_pyarrow()` also works with `conda` environments
(`conda_create()` instead of `virtualenv_create()`).

Expand All@@ -45,9 +55,9 @@ use_virtualenv("arrow-env")
pa <- import("pyarrow")
```

The package includes support for sharing Arrow `Array` and `RecordBatch`
The arrow R package include support for sharing Arrow `Array` and `RecordBatch`
objects in-process between R and Python. For example, let's create an `Array`
in `pyarrow`.
in pyarrow.

```r
a <- pa$array(c(1, 2, 3))
Expand All@@ -62,8 +72,8 @@ a
## ]
```

`a` is now an `Array` object in our R session, even though we created it in Python.
We can apply R methods on it:
`a` is now an `Array` object in your R session, even though you created it in Python.
You can apply R methods on it:

```r
a[a > 1]
Expand All@@ -76,10 +86,10 @@ a[a > 1]
## ]
```

We can send data both ways. One reason we might want to use `pyarrow` in R is
You can send data both ways. One reason you might want to use pyarrow in R is
to take advantage of functionality that is better supported in Python than in R.
For example, `pyarrow` has a `concat_arrays` function, but as of 0.17, this
function is not implemented in the `arrow` R package. We can use `reticulate`
For example, pyarrow has a `concat_arrays()` function, but as of 0.17, this
function is not implemented in the arrow R package. You can use reticulate
to use it efficiently.

```r
Expand All@@ -101,13 +111,24 @@ a_and_b
## ]
```

Now we have a single `Array` in R.
Now you have a single Array in R.

## How this works

"Send", however, isn't the correct word. Internally, we're passing pointers to
the data between the R and Python interpreters running together in the same
process, without copying anything. Nothing is being sent: we're sharing and
accessing the same internal Arrow memory buffers.

## Arrow object types

For more information about Arrow object types see the "Internals" section of
the "arrow" vignette:

```r
vignette("arrow", package = "arrow")
```

## Troubleshooting

If you get an error like
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ARROW-13401 [R]: Update python.Rmd vignette by AlenkaF · Pull Request #11914 · apache/arrow · GitHub
Skip to content
ARROW-13401 [R]: Update python.Rmd vignette#11914

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

 Closed

AlenkaF
wants to merge
9
commits into

from

 Closed


ARROW-13401 [R]: Update python.Rmd vignette
#11914
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
6d7c7af

"we" to "you"


AlenkaF Dec 9, 2021
2ae9429

Add link to the arrow vignette


AlenkaF Dec 9, 2021
c47a380

Add info about virtualenv


AlenkaF Dec 9, 2021
c931775

Make clear the package is pyarrow


AlenkaF Dec 9, 2021
b9b4dc4

Add a list of reasons to use pyarrow in R


AlenkaF Dec 9, 2021
433774f

Add How this works section


AlenkaF Dec 9, 2021
5424518

Apply suggestions from code review


AlenkaF Dec 9, 2021
9fdc08d

Update r/vignettes/python.Rmd


AlenkaF Dec 9, 2021
e5ac76e

Update r/vignettes/python.Rmd


AlenkaF Dec 9, 2021

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


39 changes: 30 additions & 9 deletions
r/vignettes/python.Rmd

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,14 @@ vignette: >
 %\VignetteEncoding{UTF-8}
---

The `arrow` package provides `reticulate` methods for passing data between
The arrow package provides [reticulate](https://rstudio.github.io/reticulate/) methods for passing data between
R and Python in the same process. This document provides a brief overview.

Why you might want to use `pyarrow`?

* To use some Python functionality that is not yet implemented in R, for example, the `concat_arrays` function.
* To transfer Python objects into R, for example, a Pandas dataframe into an R Arrow Array. 

## Installing

To use `arrow` in Python, at a minimum you'll need the `pyarrow` library.
Expand All@@ -28,6 +33,11 @@ add `nightly = TRUE`:
install_pyarrow("arrow-env", nightly = TRUE)
```

A virtualenv or a virtual environment is a specific Python installation
created for one project or purpose. It is a good practice to use
specific environments in Python so that updating a package doesn't
impact packages in other projects.
Comment thread
AlenkaF marked this conversation as resolved.


`install_pyarrow()` also works with `conda` environments
(`conda_create()` instead of `virtualenv_create()`).

Expand All@@ -45,9 +55,9 @@ use_virtualenv("arrow-env")
pa <- import("pyarrow")
```

The package includes support for sharing Arrow `Array` and `RecordBatch`
The arrow R package include support for sharing Arrow `Array` and `RecordBatch`
objects in-process between R and Python. For example, let's create an `Array`
in `pyarrow`.
in pyarrow.

```r
a <- pa$array(c(1, 2, 3))
Expand All@@ -62,8 +72,8 @@ a
## ]
```

`a` is now an `Array` object in our R session, even though we created it in Python.
We can apply R methods on it:
`a` is now an `Array` object in your R session, even though you created it in Python.
You can apply R methods on it:

```r
a[a > 1]
Expand All@@ -76,10 +86,10 @@ a[a > 1]
## ]
```

We can send data both ways. One reason we might want to use `pyarrow` in R is
You can send data both ways. One reason you might want to use pyarrow in R is
to take advantage of functionality that is better supported in Python than in R.
For example, `pyarrow` has a `concat_arrays` function, but as of 0.17, this
function is not implemented in the `arrow` R package. We can use `reticulate`
For example, pyarrow has a `concat_arrays()` function, but as of 0.17, this
function is not implemented in the arrow R package. You can use reticulate
to use it efficiently.

```r
Expand All@@ -101,13 +111,24 @@ a_and_b
## ]
```

Now we have a single `Array` in R.
Now you have a single Array in R.

## How this works

"Send", however, isn't the correct word. Internally, we're passing pointers to
the data between the R and Python interpreters running together in the same
process, without copying anything. Nothing is being sent: we're sharing and
accessing the same internal Arrow memory buffers.

## Arrow object types

For more information about Arrow object types see the "Internals" section of
the "arrow" vignette:

```r
vignette("arrow", package = "arrow")
```

## Troubleshooting

If you get an error like
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ARROW-13401 [R]: Update python.Rmd vignette by AlenkaF · Pull Request #11914 · apache/arrow · GitHub
Skip to content
ARROW-13401 [R]: Update python.Rmd vignette#11914

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

 Closed

AlenkaF
wants to merge
9
commits into

from

 Closed


ARROW-13401 [R]: Update python.Rmd vignette
#11914
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
6d7c7af

"we" to "you"


AlenkaF Dec 9, 2021
2ae9429

Add link to the arrow vignette


AlenkaF Dec 9, 2021
c47a380

Add info about virtualenv


AlenkaF Dec 9, 2021
c931775

Make clear the package is pyarrow


AlenkaF Dec 9, 2021
b9b4dc4

Add a list of reasons to use pyarrow in R


AlenkaF Dec 9, 2021
433774f

Add How this works section


AlenkaF Dec 9, 2021
5424518

Apply suggestions from code review


AlenkaF Dec 9, 2021
9fdc08d

Update r/vignettes/python.Rmd


AlenkaF Dec 9, 2021
e5ac76e

Update r/vignettes/python.Rmd


AlenkaF Dec 9, 2021

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


39 changes: 30 additions & 9 deletions
r/vignettes/python.Rmd

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,14 @@ vignette: >
 %\VignetteEncoding{UTF-8}
---

The `arrow` package provides `reticulate` methods for passing data between
The arrow package provides [reticulate](https://rstudio.github.io/reticulate/) methods for passing data between
R and Python in the same process. This document provides a brief overview.

Why you might want to use `pyarrow`?

* To use some Python functionality that is not yet implemented in R, for example, the `concat_arrays` function.
* To transfer Python objects into R, for example, a Pandas dataframe into an R Arrow Array. 

## Installing

To use `arrow` in Python, at a minimum you'll need the `pyarrow` library.
Expand All@@ -28,6 +33,11 @@ add `nightly = TRUE`:
install_pyarrow("arrow-env", nightly = TRUE)
```

A virtualenv or a virtual environment is a specific Python installation
created for one project or purpose. It is a good practice to use
specific environments in Python so that updating a package doesn't
impact packages in other projects.
Comment thread
AlenkaF marked this conversation as resolved.


`install_pyarrow()` also works with `conda` environments
(`conda_create()` instead of `virtualenv_create()`).

Expand All@@ -45,9 +55,9 @@ use_virtualenv("arrow-env")
pa <- import("pyarrow")
```

The package includes support for sharing Arrow `Array` and `RecordBatch`
The arrow R package include support for sharing Arrow `Array` and `RecordBatch`
objects in-process between R and Python. For example, let's create an `Array`
in `pyarrow`.
in pyarrow.

```r
a <- pa$array(c(1, 2, 3))
Expand All@@ -62,8 +72,8 @@ a
## ]
```

`a` is now an `Array` object in our R session, even though we created it in Python.
We can apply R methods on it:
`a` is now an `Array` object in your R session, even though you created it in Python.
You can apply R methods on it:

```r
a[a > 1]
Expand All@@ -76,10 +86,10 @@ a[a > 1]
## ]
```

We can send data both ways. One reason we might want to use `pyarrow` in R is
You can send data both ways. One reason you might want to use pyarrow in R is
to take advantage of functionality that is better supported in Python than in R.
For example, `pyarrow` has a `concat_arrays` function, but as of 0.17, this
function is not implemented in the `arrow` R package. We can use `reticulate`
For example, pyarrow has a `concat_arrays()` function, but as of 0.17, this
function is not implemented in the arrow R package. You can use reticulate
to use it efficiently.

```r
Expand All@@ -101,13 +111,24 @@ a_and_b
## ]
```

Now we have a single `Array` in R.
Now you have a single Array in R.

## How this works

"Send", however, isn't the correct word. Internally, we're passing pointers to
the data between the R and Python interpreters running together in the same
process, without copying anything. Nothing is being sent: we're sharing and
accessing the same internal Arrow memory buffers.

## Arrow object types

For more information about Arrow object types see the "Internals" section of
the "arrow" vignette:

```r
vignette("arrow", package = "arrow")
```

## Troubleshooting

If you get an error like
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
ARROW-13401 [R]: Update python.Rmd vignette by AlenkaF · Pull Request #11914 · apache/arrow · GitHub
Skip to content
ARROW-13401 [R]: Update python.Rmd vignette#11914

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

 Closed

AlenkaF
wants to merge
9
commits into

from

 Closed


ARROW-13401 [R]: Update python.Rmd vignette
#11914
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
6d7c7af

"we" to "you"


AlenkaF Dec 9, 2021
2ae9429

Add link to the arrow vignette


AlenkaF Dec 9, 2021
c47a380

Add info about virtualenv


AlenkaF Dec 9, 2021
c931775

Make clear the package is pyarrow


AlenkaF Dec 9, 2021
b9b4dc4

Add a list of reasons to use pyarrow in R


AlenkaF Dec 9, 2021
433774f

Add How this works section


AlenkaF Dec 9, 2021
5424518

Apply suggestions from code review


AlenkaF Dec 9, 2021
9fdc08d

Update r/vignettes/python.Rmd


AlenkaF Dec 9, 2021
e5ac76e

Update r/vignettes/python.Rmd


AlenkaF Dec 9, 2021

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


39 changes: 30 additions & 9 deletions
r/vignettes/python.Rmd

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,14 @@ vignette: >
 %\VignetteEncoding{UTF-8}
---

The `arrow` package provides `reticulate` methods for passing data between
The arrow package provides [reticulate](https://rstudio.github.io/reticulate/) methods for passing data between
R and Python in the same process. This document provides a brief overview.

Why you might want to use `pyarrow`?

* To use some Python functionality that is not yet implemented in R, for example, the `concat_arrays` function.
* To transfer Python objects into R, for example, a Pandas dataframe into an R Arrow Array. 

## Installing

To use `arrow` in Python, at a minimum you'll need the `pyarrow` library.
Expand All@@ -28,6 +33,11 @@ add `nightly = TRUE`:
install_pyarrow("arrow-env", nightly = TRUE)
```

A virtualenv or a virtual environment is a specific Python installation
created for one project or purpose. It is a good practice to use
specific environments in Python so that updating a package doesn't
impact packages in other projects.
Comment thread
AlenkaF marked this conversation as resolved.


`install_pyarrow()` also works with `conda` environments
(`conda_create()` instead of `virtualenv_create()`).

Expand All@@ -45,9 +55,9 @@ use_virtualenv("arrow-env")
pa <- import("pyarrow")
```

The package includes support for sharing Arrow `Array` and `RecordBatch`
The arrow R package include support for sharing Arrow `Array` and `RecordBatch`
objects in-process between R and Python. For example, let's create an `Array`
in `pyarrow`.
in pyarrow.

```r
a <- pa$array(c(1, 2, 3))
Expand All@@ -62,8 +72,8 @@ a
## ]
```

`a` is now an `Array` object in our R session, even though we created it in Python.
We can apply R methods on it:
`a` is now an `Array` object in your R session, even though you created it in Python.
You can apply R methods on it:

```r
a[a > 1]
Expand All@@ -76,10 +86,10 @@ a[a > 1]
## ]
```

We can send data both ways. One reason we might want to use `pyarrow` in R is
You can send data both ways. One reason you might want to use pyarrow in R is
to take advantage of functionality that is better supported in Python than in R.
For example, `pyarrow` has a `concat_arrays` function, but as of 0.17, this
function is not implemented in the `arrow` R package. We can use `reticulate`
For example, pyarrow has a `concat_arrays()` function, but as of 0.17, this
function is not implemented in the arrow R package. You can use reticulate
to use it efficiently.

```r
Expand All@@ -101,13 +111,24 @@ a_and_b
## ]
```

Now we have a single `Array` in R.
Now you have a single Array in R.

## How this works

"Send", however, isn't the correct word. Internally, we're passing pointers to
the data between the R and Python interpreters running together in the same
process, without copying anything. Nothing is being sent: we're sharing and
accessing the same internal Arrow memory buffers.

## Arrow object types

For more information about Arrow object types see the "Internals" section of
the "arrow" vignette:

```r
vignette("arrow", package = "arrow")
```

## Troubleshooting

If you get an error like
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ARROW-13401 [R]: Update python.Rmd vignette by AlenkaF · Pull Request #11914 · apache/arrow · GitHub
Skip to content
ARROW-13401 [R]: Update python.Rmd vignette#11914

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

 Closed

AlenkaF
wants to merge
9
commits into

from

 Closed


ARROW-13401 [R]: Update python.Rmd vignette
#11914
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
6d7c7af

"we" to "you"


AlenkaF Dec 9, 2021
2ae9429

Add link to the arrow vignette


AlenkaF Dec 9, 2021
c47a380

Add info about virtualenv


AlenkaF Dec 9, 2021
c931775

Make clear the package is pyarrow


AlenkaF Dec 9, 2021
b9b4dc4

Add a list of reasons to use pyarrow in R


AlenkaF Dec 9, 2021
433774f

Add How this works section


AlenkaF Dec 9, 2021
5424518

Apply suggestions from code review


AlenkaF Dec 9, 2021
9fdc08d

Update r/vignettes/python.Rmd


AlenkaF Dec 9, 2021
e5ac76e

Update r/vignettes/python.Rmd


AlenkaF Dec 9, 2021

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


39 changes: 30 additions & 9 deletions
r/vignettes/python.Rmd

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,14 @@ vignette: >
 %\VignetteEncoding{UTF-8}
---

The `arrow` package provides `reticulate` methods for passing data between
The arrow package provides [reticulate](https://rstudio.github.io/reticulate/) methods for passing data between
R and Python in the same process. This document provides a brief overview.

Why you might want to use `pyarrow`?

* To use some Python functionality that is not yet implemented in R, for example, the `concat_arrays` function.
* To transfer Python objects into R, for example, a Pandas dataframe into an R Arrow Array. 

## Installing

To use `arrow` in Python, at a minimum you'll need the `pyarrow` library.
Expand All@@ -28,6 +33,11 @@ add `nightly = TRUE`:
install_pyarrow("arrow-env", nightly = TRUE)
```

A virtualenv or a virtual environment is a specific Python installation
created for one project or purpose. It is a good practice to use
specific environments in Python so that updating a package doesn't
impact packages in other projects.
Comment thread
AlenkaF marked this conversation as resolved.


`install_pyarrow()` also works with `conda` environments
(`conda_create()` instead of `virtualenv_create()`).

Expand All@@ -45,9 +55,9 @@ use_virtualenv("arrow-env")
pa <- import("pyarrow")
```

The package includes support for sharing Arrow `Array` and `RecordBatch`
The arrow R package include support for sharing Arrow `Array` and `RecordBatch`
objects in-process between R and Python. For example, let's create an `Array`
in `pyarrow`.
in pyarrow.

```r
a <- pa$array(c(1, 2, 3))
Expand All@@ -62,8 +72,8 @@ a
## ]
```

`a` is now an `Array` object in our R session, even though we created it in Python.
We can apply R methods on it:
`a` is now an `Array` object in your R session, even though you created it in Python.
You can apply R methods on it:

```r
a[a > 1]
Expand All@@ -76,10 +86,10 @@ a[a > 1]
## ]
```

We can send data both ways. One reason we might want to use `pyarrow` in R is
You can send data both ways. One reason you might want to use pyarrow in R is
to take advantage of functionality that is better supported in Python than in R.
For example, `pyarrow` has a `concat_arrays` function, but as of 0.17, this
function is not implemented in the `arrow` R package. We can use `reticulate`
For example, pyarrow has a `concat_arrays()` function, but as of 0.17, this
function is not implemented in the arrow R package. You can use reticulate
to use it efficiently.

```r
Expand All@@ -101,13 +111,24 @@ a_and_b
## ]
```

Now we have a single `Array` in R.
Now you have a single Array in R.

## How this works

"Send", however, isn't the correct word. Internally, we're passing pointers to
the data between the R and Python interpreters running together in the same
process, without copying anything. Nothing is being sent: we're sharing and
accessing the same internal Arrow memory buffers.

## Arrow object types

For more information about Arrow object types see the "Internals" section of
the "arrow" vignette:

```r
vignette("arrow", package = "arrow")
```

## Troubleshooting

If you get an error like
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ARROW-13401 [R]: Update python.Rmd vignette by AlenkaF · Pull Request #11914 · apache/arrow · GitHub
Skip to content
ARROW-13401 [R]: Update python.Rmd vignette#11914

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

 Closed

AlenkaF
wants to merge
9
commits into

from

 Closed


ARROW-13401 [R]: Update python.Rmd vignette
#11914
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
6d7c7af

"we" to "you"


AlenkaF Dec 9, 2021
2ae9429

Add link to the arrow vignette


AlenkaF Dec 9, 2021
c47a380

Add info about virtualenv


AlenkaF Dec 9, 2021
c931775

Make clear the package is pyarrow


AlenkaF Dec 9, 2021
b9b4dc4

Add a list of reasons to use pyarrow in R


AlenkaF Dec 9, 2021
433774f

Add How this works section


AlenkaF Dec 9, 2021
5424518

Apply suggestions from code review


AlenkaF Dec 9, 2021
9fdc08d

Update r/vignettes/python.Rmd


AlenkaF Dec 9, 2021
e5ac76e

Update r/vignettes/python.Rmd


AlenkaF Dec 9, 2021

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


39 changes: 30 additions & 9 deletions
r/vignettes/python.Rmd

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,14 @@ vignette: >
 %\VignetteEncoding{UTF-8}
---

The `arrow` package provides `reticulate` methods for passing data between
The arrow package provides [reticulate](https://rstudio.github.io/reticulate/) methods for passing data between
R and Python in the same process. This document provides a brief overview.

Why you might want to use `pyarrow`?

* To use some Python functionality that is not yet implemented in R, for example, the `concat_arrays` function.
* To transfer Python objects into R, for example, a Pandas dataframe into an R Arrow Array. 

## Installing

To use `arrow` in Python, at a minimum you'll need the `pyarrow` library.
Expand All@@ -28,6 +33,11 @@ add `nightly = TRUE`:
install_pyarrow("arrow-env", nightly = TRUE)
```

A virtualenv or a virtual environment is a specific Python installation
created for one project or purpose. It is a good practice to use
specific environments in Python so that updating a package doesn't
impact packages in other projects.
Comment thread
AlenkaF marked this conversation as resolved.


`install_pyarrow()` also works with `conda` environments
(`conda_create()` instead of `virtualenv_create()`).

Expand All@@ -45,9 +55,9 @@ use_virtualenv("arrow-env")
pa <- import("pyarrow")
```

The package includes support for sharing Arrow `Array` and `RecordBatch`
The arrow R package include support for sharing Arrow `Array` and `RecordBatch`
objects in-process between R and Python. For example, let's create an `Array`
in `pyarrow`.
in pyarrow.

```r
a <- pa$array(c(1, 2, 3))
Expand All@@ -62,8 +72,8 @@ a
## ]
```

`a` is now an `Array` object in our R session, even though we created it in Python.
We can apply R methods on it:
`a` is now an `Array` object in your R session, even though you created it in Python.
You can apply R methods on it:

```r
a[a > 1]
Expand All@@ -76,10 +86,10 @@ a[a > 1]
## ]
```

We can send data both ways. One reason we might want to use `pyarrow` in R is
You can send data both ways. One reason you might want to use pyarrow in R is
to take advantage of functionality that is better supported in Python than in R.
For example, `pyarrow` has a `concat_arrays` function, but as of 0.17, this
function is not implemented in the `arrow` R package. We can use `reticulate`
For example, pyarrow has a `concat_arrays()` function, but as of 0.17, this
function is not implemented in the arrow R package. You can use reticulate
to use it efficiently.

```r
Expand All@@ -101,13 +111,24 @@ a_and_b
## ]
```

Now we have a single `Array` in R.
Now you have a single Array in R.

## How this works

"Send", however, isn't the correct word. Internally, we're passing pointers to
the data between the R and Python interpreters running together in the same
process, without copying anything. Nothing is being sent: we're sharing and
accessing the same internal Arrow memory buffers.

## Arrow object types

For more information about Arrow object types see the "Internals" section of
the "arrow" vignette:

```r
vignette("arrow", package = "arrow")
```

## Troubleshooting

If you get an error like
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
ARROW-13401 [R]: Update python.Rmd vignette by AlenkaF · Pull Request #11914 · apache/arrow · GitHub
Skip to content
ARROW-13401 [R]: Update python.Rmd vignette#11914

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

 Closed

AlenkaF
wants to merge
9
commits into

from

 Closed


ARROW-13401 [R]: Update python.Rmd vignette
#11914
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
6d7c7af

"we" to "you"


AlenkaF Dec 9, 2021
2ae9429

Add link to the arrow vignette


AlenkaF Dec 9, 2021
c47a380

Add info about virtualenv


AlenkaF Dec 9, 2021
c931775

Make clear the package is pyarrow


AlenkaF Dec 9, 2021
b9b4dc4

Add a list of reasons to use pyarrow in R


AlenkaF Dec 9, 2021
433774f

Add How this works section


AlenkaF Dec 9, 2021
5424518

Apply suggestions from code review


AlenkaF Dec 9, 2021
9fdc08d

Update r/vignettes/python.Rmd


AlenkaF Dec 9, 2021
e5ac76e

Update r/vignettes/python.Rmd


AlenkaF Dec 9, 2021

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


39 changes: 30 additions & 9 deletions
r/vignettes/python.Rmd

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,14 @@ vignette: >
 %\VignetteEncoding{UTF-8}
---

The `arrow` package provides `reticulate` methods for passing data between
The arrow package provides [reticulate](https://rstudio.github.io/reticulate/) methods for passing data between
R and Python in the same process. This document provides a brief overview.

Why you might want to use `pyarrow`?

* To use some Python functionality that is not yet implemented in R, for example, the `concat_arrays` function.
* To transfer Python objects into R, for example, a Pandas dataframe into an R Arrow Array. 

## Installing

To use `arrow` in Python, at a minimum you'll need the `pyarrow` library.
Expand All@@ -28,6 +33,11 @@ add `nightly = TRUE`:
install_pyarrow("arrow-env", nightly = TRUE)
```

A virtualenv or a virtual environment is a specific Python installation
created for one project or purpose. It is a good practice to use
specific environments in Python so that updating a package doesn't
impact packages in other projects.
Comment thread
AlenkaF marked this conversation as resolved.


`install_pyarrow()` also works with `conda` environments
(`conda_create()` instead of `virtualenv_create()`).

Expand All@@ -45,9 +55,9 @@ use_virtualenv("arrow-env")
pa <- import("pyarrow")
```

The package includes support for sharing Arrow `Array` and `RecordBatch`
The arrow R package include support for sharing Arrow `Array` and `RecordBatch`
objects in-process between R and Python. For example, let's create an `Array`
in `pyarrow`.
in pyarrow.

```r
a <- pa$array(c(1, 2, 3))
Expand All@@ -62,8 +72,8 @@ a
## ]
```

`a` is now an `Array` object in our R session, even though we created it in Python.
We can apply R methods on it:
`a` is now an `Array` object in your R session, even though you created it in Python.
You can apply R methods on it:

```r
a[a > 1]
Expand All@@ -76,10 +86,10 @@ a[a > 1]
## ]
```

We can send data both ways. One reason we might want to use `pyarrow` in R is
You can send data both ways. One reason you might want to use pyarrow in R is
to take advantage of functionality that is better supported in Python than in R.
For example, `pyarrow` has a `concat_arrays` function, but as of 0.17, this
function is not implemented in the `arrow` R package. We can use `reticulate`
For example, pyarrow has a `concat_arrays()` function, but as of 0.17, this
function is not implemented in the arrow R package. You can use reticulate
to use it efficiently.

```r
Expand All@@ -101,13 +111,24 @@ a_and_b
## ]
```

Now we have a single `Array` in R.
Now you have a single Array in R.

## How this works

"Send", however, isn't the correct word. Internally, we're passing pointers to
the data between the R and Python interpreters running together in the same
process, without copying anything. Nothing is being sent: we're sharing and
accessing the same internal Arrow memory buffers.

## Arrow object types

For more information about Arrow object types see the "Internals" section of
the "arrow" vignette:

```r
vignette("arrow", package = "arrow")
```

## Troubleshooting

If you get an error like
Expand Down