Skip to content

ARROW-13397: [R] Update arrow.Rmd vignette#11202

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
thisisnic wants to merge 3 commits into from
Closed

ARROW-13397: [R] Update arrow.Rmd vignette #11202

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1d52b74
Re-order conversion tables, restart numbering, add explanation of flo…
thisisnic Sep 21, 2021
c367f04
Remove extraneous reference
thisisnic Oct 4, 2021
2d90eef
add "currently"
thisisnic Oct 6, 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
65 changes: 42 additions & 23 deletions r/vignettes/arrow.Rmd
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -125,22 +125,31 @@ In the tables, entries with a `-` are not currently implemented.
|--------------------------|------------|
| logical | boolean |
| integer | int32 |
| double ("numeric") | float64 |
| character | utf8^1^ |
| double ("numeric") | float64^1^ |
| character | utf8^2^ |
| factor | dictionary |
| raw | uint8 |
| Date | date32 |
| POSIXct | timestamp |
| POSIXlt | struct |
| data.frame | struct |
| list^2^ | list |
| list^3^ | list |
| bit64::integer64 | int64 |
| difftime | time32 |
| vctrs::vctrs_unspecified | null |

^1^: If the character vector exceeds 2GB of strings, it will be converted to a `large_utf8` Arrow type

^2^: Only lists where all elements are the same type are able to be translated to Arrow list type (which is a "list of" some type).

^1^: `float64` and `double` are the same concept and data type in Arrow C++;
however, only `float64()` is used in arrow as the function `double()` already
exists in base R

^2^: If the character vector exceeds 2GB of strings, it will be converted to a
`large_utf8` Arrow type

^3^: Only lists where all elements are the same type are able to be translated
to Arrow list type (which is a "list of" some type).


### Arrow to R

Expand All@@ -150,42 +159,52 @@ In the tables, entries with a `-` are not currently implemented.
| int8 | integer |
| int16 | integer |
| int32 | integer |
| int64 | integer^3^ |
| int64 | integer^1^ |
| uint8 | integer |
| uint16 | integer |
| uint32 | integer^3^ |
| uint64 | integer^3^ |
| float16 | - |
| uint32 | integer^1^ |
| uint64 | integer^1^ |
| float16 | -^2^ |
| float32 | double |
| float64 | double |
| utf8 | character |
| binary | arrow_binary ^5^ |
| fixed_size_binary | arrow_fixed_size_binary ^5^ |
| large_utf8 | character |
| binary | arrow_binary ^3^ |
| large_binary | arrow_large_binary ^3^ |
| fixed_size_binary | arrow_fixed_size_binary ^3^ |
| date32 | Date |
| date64 | POSIXct |
| time32 | hms::difftime |
| time64 | hms::difftime |
| timestamp | POSIXct |
| duration | - |
| duration | -^2^ |
| decimal | double |
| dictionary | factor^4^ |
| list | arrow_list ^6^ |
| fixed_size_list | arrow_fixed_size_list ^6^ |
| list | arrow_list ^5^ |
| large_list | arrow_large_list ^5^ |
| fixed_size_list | arrow_fixed_size_list ^5^ |
| struct | data.frame |
| null | vctrs::vctrs_unspecified |
| map | - |
| union | - |
| large_utf8 | character |
| large_binary | arrow_large_binary ^5^ |
| large_list | arrow_large_list ^6^ |
| map | -^2^ |
| union | -^2^ |

^1^: These integer types may contain values that exceed the range of R's
`integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are
converted to `double` ("numeric") and `int64` is converted to
`bit64::integer64`. This conversion can be disabled (so that `int64` always
yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.

^2^: Some Arrow data types do not currently have an R equivalent and will raise an error
if cast to or mapped to via a schema.

@jonkeanejonkeaneOct 5, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Might we mention something like "do not yet have an R equivalent"? At least for duration I imagine we will map it on to lubridate's duration type at some point?

@thisisnicthisisnicOct 6, 2021

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Sounds good

@thisisnicthisisnicOct 6, 2021

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Done


^3^: These integer types may contain values that exceed the range of R's `integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are converted to `double` ("numeric") and `int64` is converted to `bit64::integer64`. This conversion can be disabled (so that `int64` always yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.
^3^: `arrow*_binary` classes are implemented as lists of raw vectors.

^4^: Due to the limitation of R `factor`s, Arrow `dictionary` values are coerced to string when translated to R if they are not already strings.
^4^: Due to the limitation of R factors, Arrow `dictionary` values are coerced
to string when translated to R if they are not already strings.

@jonkeanejonkeaneOct 5, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This isn't relevant in this doc, but now I'm curious: what is the limitation of R factors here?

@thisisnicthisisnicOct 6, 2021

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Not a clue tbh; I think @ianmcook may(?) have written this text originally, so might have a better idea than me


^5^: `arrow*_binary` classes are implemented as lists of raw vectors.
^5^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of`
with a `ptype` attribute set to what an empty Array of the value type converts to.

^6^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` with a `ptype` attribute set to what an empty Array of the value type converts to.

### R object attributes

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-13397: [R] Update arrow.Rmd vignette by thisisnic · Pull Request #11202 · apache/arrow · GitHub
Skip to content
ARROW-13397: [R] Update arrow.Rmd vignette#11202

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

thisisnic
wants to merge
3
commits into

from

 Closed


ARROW-13397: [R] Update arrow.Rmd vignette
#11202
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
1d52b74

Re-order conversion tables, restart numbering, add explanation of flo…


thisisnic Sep 21, 2021
c367f04

Remove extraneous reference


thisisnic Oct 4, 2021
2d90eef

add "currently"


thisisnic Oct 6, 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


65 changes: 42 additions & 23 deletions
r/vignettes/arrow.Rmd

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -125,22 +125,31 @@ In the tables, entries with a `-` are not currently implemented.
|--------------------------|------------|
| logical | boolean |
| integer | int32 |
| double ("numeric") | float64 |
| character | utf8^1^ |
| double ("numeric") | float64^1^ |
| character | utf8^2^ |
| factor | dictionary |
| raw | uint8 |
| Date | date32 |
| POSIXct | timestamp |
| POSIXlt | struct |
| data.frame | struct |
| list^2^ | list |
| list^3^ | list |
| bit64::integer64 | int64 |
| difftime | time32 |
| vctrs::vctrs_unspecified | null |

^1^: If the character vector exceeds 2GB of strings, it will be converted to a `large_utf8` Arrow type

^2^: Only lists where all elements are the same type are able to be translated to Arrow list type (which is a "list of" some type).

^1^: `float64` and `double` are the same concept and data type in Arrow C++; 
however, only `float64()` is used in arrow as the function `double()` already 
exists in base R

^2^: If the character vector exceeds 2GB of strings, it will be converted to a 
`large_utf8` Arrow type

^3^: Only lists where all elements are the same type are able to be translated 
to Arrow list type (which is a "list of" some type).


### Arrow to R

Expand All@@ -150,42 +159,52 @@ In the tables, entries with a `-` are not currently implemented.
| int8 | integer |
| int16 | integer |
| int32 | integer |
| int64 | integer^3^ |
| int64 | integer^1^ |
| uint8 | integer |
| uint16 | integer |
| uint32 | integer^3^ |
| uint64 | integer^3^ |
| float16 | - |
| uint32 | integer^1^ |
| uint64 | integer^1^ |
| float16 | -^2^ |
| float32 | double |
| float64 | double |
| utf8 | character |
| binary | arrow_binary ^5^ |
| fixed_size_binary | arrow_fixed_size_binary ^5^ |
| large_utf8 | character |
| binary | arrow_binary ^3^ |
| large_binary | arrow_large_binary ^3^ |
| fixed_size_binary | arrow_fixed_size_binary ^3^ |
| date32 | Date |
| date64 | POSIXct |
| time32 | hms::difftime |
| time64 | hms::difftime |
| timestamp | POSIXct |
| duration | - |
| duration | -^2^ |
| decimal | double |
| dictionary | factor^4^ |
| list | arrow_list ^6^ |
| fixed_size_list | arrow_fixed_size_list ^6^ |
| list | arrow_list ^5^ |
| large_list | arrow_large_list ^5^ |
| fixed_size_list | arrow_fixed_size_list ^5^ |
| struct | data.frame |
| null | vctrs::vctrs_unspecified |
| map | - |
| union | - |
| large_utf8 | character |
| large_binary | arrow_large_binary ^5^ |
| large_list | arrow_large_list ^6^ |
| map | -^2^ |
| union | -^2^ |

^1^: These integer types may contain values that exceed the range of R's 
`integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are 
converted to `double` ("numeric") and `int64` is converted to 
`bit64::integer64`. This conversion can be disabled (so that `int64` always
yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.

^2^: Some Arrow data types do not currently have an R equivalent and will raise an error
if cast to or mapped to via a schema.
@jonkeanejonkeaneOct 5, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Might we mention something like "do not yet have an R equivalent"? At least for duration I imagine we will map it on to lubridate's duration type at some point?
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Sounds good
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Done

^3^: These integer types may contain values that exceed the range of R's `integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are converted to `double` ("numeric") and `int64` is converted to `bit64::integer64`. This conversion can be disabled (so that `int64` always yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.
^3^: `arrow*_binary` classes are implemented as lists of raw vectors. 

^4^: Due to the limitation of R `factor`s, Arrow `dictionary` values are coerced to string when translated to R if they are not already strings.
^4^: Due to the limitation of R factors, Arrow `dictionary` values are coerced
to string when translated to R if they are not already strings.
@jonkeanejonkeaneOct 5, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This isn't relevant in this doc, but now I'm curious: what is the limitation of R factors here?
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Not a clue tbh; I think @ianmcook may(?) have written this text originally, so might have a better idea than me

^5^: `arrow*_binary` classes are implemented as lists of raw vectors. 
^5^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` 
with a `ptype` attribute set to what an empty Array of the value type converts to. 

^6^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` with a `ptype` attribute set to what an empty Array of the value type converts to. 

### R object attributes

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-13397: [R] Update arrow.Rmd vignette by thisisnic · Pull Request #11202 · apache/arrow · GitHub
Skip to content
ARROW-13397: [R] Update arrow.Rmd vignette#11202

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

thisisnic
wants to merge
3
commits into

from

 Closed


ARROW-13397: [R] Update arrow.Rmd vignette
#11202
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
1d52b74

Re-order conversion tables, restart numbering, add explanation of flo…


thisisnic Sep 21, 2021
c367f04

Remove extraneous reference


thisisnic Oct 4, 2021
2d90eef

add "currently"


thisisnic Oct 6, 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


65 changes: 42 additions & 23 deletions
r/vignettes/arrow.Rmd

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -125,22 +125,31 @@ In the tables, entries with a `-` are not currently implemented.
|--------------------------|------------|
| logical | boolean |
| integer | int32 |
| double ("numeric") | float64 |
| character | utf8^1^ |
| double ("numeric") | float64^1^ |
| character | utf8^2^ |
| factor | dictionary |
| raw | uint8 |
| Date | date32 |
| POSIXct | timestamp |
| POSIXlt | struct |
| data.frame | struct |
| list^2^ | list |
| list^3^ | list |
| bit64::integer64 | int64 |
| difftime | time32 |
| vctrs::vctrs_unspecified | null |

^1^: If the character vector exceeds 2GB of strings, it will be converted to a `large_utf8` Arrow type

^2^: Only lists where all elements are the same type are able to be translated to Arrow list type (which is a "list of" some type).

^1^: `float64` and `double` are the same concept and data type in Arrow C++; 
however, only `float64()` is used in arrow as the function `double()` already 
exists in base R

^2^: If the character vector exceeds 2GB of strings, it will be converted to a 
`large_utf8` Arrow type

^3^: Only lists where all elements are the same type are able to be translated 
to Arrow list type (which is a "list of" some type).


### Arrow to R

Expand All@@ -150,42 +159,52 @@ In the tables, entries with a `-` are not currently implemented.
| int8 | integer |
| int16 | integer |
| int32 | integer |
| int64 | integer^3^ |
| int64 | integer^1^ |
| uint8 | integer |
| uint16 | integer |
| uint32 | integer^3^ |
| uint64 | integer^3^ |
| float16 | - |
| uint32 | integer^1^ |
| uint64 | integer^1^ |
| float16 | -^2^ |
| float32 | double |
| float64 | double |
| utf8 | character |
| binary | arrow_binary ^5^ |
| fixed_size_binary | arrow_fixed_size_binary ^5^ |
| large_utf8 | character |
| binary | arrow_binary ^3^ |
| large_binary | arrow_large_binary ^3^ |
| fixed_size_binary | arrow_fixed_size_binary ^3^ |
| date32 | Date |
| date64 | POSIXct |
| time32 | hms::difftime |
| time64 | hms::difftime |
| timestamp | POSIXct |
| duration | - |
| duration | -^2^ |
| decimal | double |
| dictionary | factor^4^ |
| list | arrow_list ^6^ |
| fixed_size_list | arrow_fixed_size_list ^6^ |
| list | arrow_list ^5^ |
| large_list | arrow_large_list ^5^ |
| fixed_size_list | arrow_fixed_size_list ^5^ |
| struct | data.frame |
| null | vctrs::vctrs_unspecified |
| map | - |
| union | - |
| large_utf8 | character |
| large_binary | arrow_large_binary ^5^ |
| large_list | arrow_large_list ^6^ |
| map | -^2^ |
| union | -^2^ |

^1^: These integer types may contain values that exceed the range of R's 
`integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are 
converted to `double` ("numeric") and `int64` is converted to 
`bit64::integer64`. This conversion can be disabled (so that `int64` always
yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.

^2^: Some Arrow data types do not currently have an R equivalent and will raise an error
if cast to or mapped to via a schema.
@jonkeanejonkeaneOct 5, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Might we mention something like "do not yet have an R equivalent"? At least for duration I imagine we will map it on to lubridate's duration type at some point?
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Sounds good
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Done

^3^: These integer types may contain values that exceed the range of R's `integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are converted to `double` ("numeric") and `int64` is converted to `bit64::integer64`. This conversion can be disabled (so that `int64` always yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.
^3^: `arrow*_binary` classes are implemented as lists of raw vectors. 

^4^: Due to the limitation of R `factor`s, Arrow `dictionary` values are coerced to string when translated to R if they are not already strings.
^4^: Due to the limitation of R factors, Arrow `dictionary` values are coerced
to string when translated to R if they are not already strings.
@jonkeanejonkeaneOct 5, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This isn't relevant in this doc, but now I'm curious: what is the limitation of R factors here?
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Not a clue tbh; I think @ianmcook may(?) have written this text originally, so might have a better idea than me

^5^: `arrow*_binary` classes are implemented as lists of raw vectors. 
^5^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` 
with a `ptype` attribute set to what an empty Array of the value type converts to. 

^6^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` with a `ptype` attribute set to what an empty Array of the value type converts to. 

### R object attributes

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-13397: [R] Update arrow.Rmd vignette by thisisnic · Pull Request #11202 · apache/arrow · GitHub
Skip to content
ARROW-13397: [R] Update arrow.Rmd vignette#11202

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

thisisnic
wants to merge
3
commits into

from

 Closed


ARROW-13397: [R] Update arrow.Rmd vignette
#11202
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
1d52b74

Re-order conversion tables, restart numbering, add explanation of flo…


thisisnic Sep 21, 2021
c367f04

Remove extraneous reference


thisisnic Oct 4, 2021
2d90eef

add "currently"


thisisnic Oct 6, 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


65 changes: 42 additions & 23 deletions
r/vignettes/arrow.Rmd

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -125,22 +125,31 @@ In the tables, entries with a `-` are not currently implemented.
|--------------------------|------------|
| logical | boolean |
| integer | int32 |
| double ("numeric") | float64 |
| character | utf8^1^ |
| double ("numeric") | float64^1^ |
| character | utf8^2^ |
| factor | dictionary |
| raw | uint8 |
| Date | date32 |
| POSIXct | timestamp |
| POSIXlt | struct |
| data.frame | struct |
| list^2^ | list |
| list^3^ | list |
| bit64::integer64 | int64 |
| difftime | time32 |
| vctrs::vctrs_unspecified | null |

^1^: If the character vector exceeds 2GB of strings, it will be converted to a `large_utf8` Arrow type

^2^: Only lists where all elements are the same type are able to be translated to Arrow list type (which is a "list of" some type).

^1^: `float64` and `double` are the same concept and data type in Arrow C++; 
however, only `float64()` is used in arrow as the function `double()` already 
exists in base R

^2^: If the character vector exceeds 2GB of strings, it will be converted to a 
`large_utf8` Arrow type

^3^: Only lists where all elements are the same type are able to be translated 
to Arrow list type (which is a "list of" some type).


### Arrow to R

Expand All@@ -150,42 +159,52 @@ In the tables, entries with a `-` are not currently implemented.
| int8 | integer |
| int16 | integer |
| int32 | integer |
| int64 | integer^3^ |
| int64 | integer^1^ |
| uint8 | integer |
| uint16 | integer |
| uint32 | integer^3^ |
| uint64 | integer^3^ |
| float16 | - |
| uint32 | integer^1^ |
| uint64 | integer^1^ |
| float16 | -^2^ |
| float32 | double |
| float64 | double |
| utf8 | character |
| binary | arrow_binary ^5^ |
| fixed_size_binary | arrow_fixed_size_binary ^5^ |
| large_utf8 | character |
| binary | arrow_binary ^3^ |
| large_binary | arrow_large_binary ^3^ |
| fixed_size_binary | arrow_fixed_size_binary ^3^ |
| date32 | Date |
| date64 | POSIXct |
| time32 | hms::difftime |
| time64 | hms::difftime |
| timestamp | POSIXct |
| duration | - |
| duration | -^2^ |
| decimal | double |
| dictionary | factor^4^ |
| list | arrow_list ^6^ |
| fixed_size_list | arrow_fixed_size_list ^6^ |
| list | arrow_list ^5^ |
| large_list | arrow_large_list ^5^ |
| fixed_size_list | arrow_fixed_size_list ^5^ |
| struct | data.frame |
| null | vctrs::vctrs_unspecified |
| map | - |
| union | - |
| large_utf8 | character |
| large_binary | arrow_large_binary ^5^ |
| large_list | arrow_large_list ^6^ |
| map | -^2^ |
| union | -^2^ |

^1^: These integer types may contain values that exceed the range of R's 
`integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are 
converted to `double` ("numeric") and `int64` is converted to 
`bit64::integer64`. This conversion can be disabled (so that `int64` always
yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.

^2^: Some Arrow data types do not currently have an R equivalent and will raise an error
if cast to or mapped to via a schema.
@jonkeanejonkeaneOct 5, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Might we mention something like "do not yet have an R equivalent"? At least for duration I imagine we will map it on to lubridate's duration type at some point?
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Sounds good
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Done

^3^: These integer types may contain values that exceed the range of R's `integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are converted to `double` ("numeric") and `int64` is converted to `bit64::integer64`. This conversion can be disabled (so that `int64` always yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.
^3^: `arrow*_binary` classes are implemented as lists of raw vectors. 

^4^: Due to the limitation of R `factor`s, Arrow `dictionary` values are coerced to string when translated to R if they are not already strings.
^4^: Due to the limitation of R factors, Arrow `dictionary` values are coerced
to string when translated to R if they are not already strings.
@jonkeanejonkeaneOct 5, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This isn't relevant in this doc, but now I'm curious: what is the limitation of R factors here?
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Not a clue tbh; I think @ianmcook may(?) have written this text originally, so might have a better idea than me

^5^: `arrow*_binary` classes are implemented as lists of raw vectors. 
^5^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` 
with a `ptype` attribute set to what an empty Array of the value type converts to. 

^6^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` with a `ptype` attribute set to what an empty Array of the value type converts to. 

### R object attributes

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-13397: [R] Update arrow.Rmd vignette by thisisnic · Pull Request #11202 · apache/arrow · GitHub
Skip to content
ARROW-13397: [R] Update arrow.Rmd vignette#11202

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

thisisnic
wants to merge
3
commits into

from

 Closed


ARROW-13397: [R] Update arrow.Rmd vignette
#11202
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
1d52b74

Re-order conversion tables, restart numbering, add explanation of flo…


thisisnic Sep 21, 2021
c367f04

Remove extraneous reference


thisisnic Oct 4, 2021
2d90eef

add "currently"


thisisnic Oct 6, 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


65 changes: 42 additions & 23 deletions
r/vignettes/arrow.Rmd

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -125,22 +125,31 @@ In the tables, entries with a `-` are not currently implemented.
|--------------------------|------------|
| logical | boolean |
| integer | int32 |
| double ("numeric") | float64 |
| character | utf8^1^ |
| double ("numeric") | float64^1^ |
| character | utf8^2^ |
| factor | dictionary |
| raw | uint8 |
| Date | date32 |
| POSIXct | timestamp |
| POSIXlt | struct |
| data.frame | struct |
| list^2^ | list |
| list^3^ | list |
| bit64::integer64 | int64 |
| difftime | time32 |
| vctrs::vctrs_unspecified | null |

^1^: If the character vector exceeds 2GB of strings, it will be converted to a `large_utf8` Arrow type

^2^: Only lists where all elements are the same type are able to be translated to Arrow list type (which is a "list of" some type).

^1^: `float64` and `double` are the same concept and data type in Arrow C++; 
however, only `float64()` is used in arrow as the function `double()` already 
exists in base R

^2^: If the character vector exceeds 2GB of strings, it will be converted to a 
`large_utf8` Arrow type

^3^: Only lists where all elements are the same type are able to be translated 
to Arrow list type (which is a "list of" some type).


### Arrow to R

Expand All@@ -150,42 +159,52 @@ In the tables, entries with a `-` are not currently implemented.
| int8 | integer |
| int16 | integer |
| int32 | integer |
| int64 | integer^3^ |
| int64 | integer^1^ |
| uint8 | integer |
| uint16 | integer |
| uint32 | integer^3^ |
| uint64 | integer^3^ |
| float16 | - |
| uint32 | integer^1^ |
| uint64 | integer^1^ |
| float16 | -^2^ |
| float32 | double |
| float64 | double |
| utf8 | character |
| binary | arrow_binary ^5^ |
| fixed_size_binary | arrow_fixed_size_binary ^5^ |
| large_utf8 | character |
| binary | arrow_binary ^3^ |
| large_binary | arrow_large_binary ^3^ |
| fixed_size_binary | arrow_fixed_size_binary ^3^ |
| date32 | Date |
| date64 | POSIXct |
| time32 | hms::difftime |
| time64 | hms::difftime |
| timestamp | POSIXct |
| duration | - |
| duration | -^2^ |
| decimal | double |
| dictionary | factor^4^ |
| list | arrow_list ^6^ |
| fixed_size_list | arrow_fixed_size_list ^6^ |
| list | arrow_list ^5^ |
| large_list | arrow_large_list ^5^ |
| fixed_size_list | arrow_fixed_size_list ^5^ |
| struct | data.frame |
| null | vctrs::vctrs_unspecified |
| map | - |
| union | - |
| large_utf8 | character |
| large_binary | arrow_large_binary ^5^ |
| large_list | arrow_large_list ^6^ |
| map | -^2^ |
| union | -^2^ |

^1^: These integer types may contain values that exceed the range of R's 
`integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are 
converted to `double` ("numeric") and `int64` is converted to 
`bit64::integer64`. This conversion can be disabled (so that `int64` always
yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.

^2^: Some Arrow data types do not currently have an R equivalent and will raise an error
if cast to or mapped to via a schema.
@jonkeanejonkeaneOct 5, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Might we mention something like "do not yet have an R equivalent"? At least for duration I imagine we will map it on to lubridate's duration type at some point?
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Sounds good
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Done

^3^: These integer types may contain values that exceed the range of R's `integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are converted to `double` ("numeric") and `int64` is converted to `bit64::integer64`. This conversion can be disabled (so that `int64` always yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.
^3^: `arrow*_binary` classes are implemented as lists of raw vectors. 

^4^: Due to the limitation of R `factor`s, Arrow `dictionary` values are coerced to string when translated to R if they are not already strings.
^4^: Due to the limitation of R factors, Arrow `dictionary` values are coerced
to string when translated to R if they are not already strings.
@jonkeanejonkeaneOct 5, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This isn't relevant in this doc, but now I'm curious: what is the limitation of R factors here?
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Not a clue tbh; I think @ianmcook may(?) have written this text originally, so might have a better idea than me

^5^: `arrow*_binary` classes are implemented as lists of raw vectors. 
^5^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` 
with a `ptype` attribute set to what an empty Array of the value type converts to. 

^6^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` with a `ptype` attribute set to what an empty Array of the value type converts to. 

### R object attributes

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-13397: [R] Update arrow.Rmd vignette by thisisnic · Pull Request #11202 · apache/arrow · GitHub
Skip to content
ARROW-13397: [R] Update arrow.Rmd vignette#11202

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

thisisnic
wants to merge
3
commits into

from

 Closed


ARROW-13397: [R] Update arrow.Rmd vignette
#11202
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
1d52b74

Re-order conversion tables, restart numbering, add explanation of flo…


thisisnic Sep 21, 2021
c367f04

Remove extraneous reference


thisisnic Oct 4, 2021
2d90eef

add "currently"


thisisnic Oct 6, 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


65 changes: 42 additions & 23 deletions
r/vignettes/arrow.Rmd

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -125,22 +125,31 @@ In the tables, entries with a `-` are not currently implemented.
|--------------------------|------------|
| logical | boolean |
| integer | int32 |
| double ("numeric") | float64 |
| character | utf8^1^ |
| double ("numeric") | float64^1^ |
| character | utf8^2^ |
| factor | dictionary |
| raw | uint8 |
| Date | date32 |
| POSIXct | timestamp |
| POSIXlt | struct |
| data.frame | struct |
| list^2^ | list |
| list^3^ | list |
| bit64::integer64 | int64 |
| difftime | time32 |
| vctrs::vctrs_unspecified | null |

^1^: If the character vector exceeds 2GB of strings, it will be converted to a `large_utf8` Arrow type

^2^: Only lists where all elements are the same type are able to be translated to Arrow list type (which is a "list of" some type).

^1^: `float64` and `double` are the same concept and data type in Arrow C++; 
however, only `float64()` is used in arrow as the function `double()` already 
exists in base R

^2^: If the character vector exceeds 2GB of strings, it will be converted to a 
`large_utf8` Arrow type

^3^: Only lists where all elements are the same type are able to be translated 
to Arrow list type (which is a "list of" some type).


### Arrow to R

Expand All@@ -150,42 +159,52 @@ In the tables, entries with a `-` are not currently implemented.
| int8 | integer |
| int16 | integer |
| int32 | integer |
| int64 | integer^3^ |
| int64 | integer^1^ |
| uint8 | integer |
| uint16 | integer |
| uint32 | integer^3^ |
| uint64 | integer^3^ |
| float16 | - |
| uint32 | integer^1^ |
| uint64 | integer^1^ |
| float16 | -^2^ |
| float32 | double |
| float64 | double |
| utf8 | character |
| binary | arrow_binary ^5^ |
| fixed_size_binary | arrow_fixed_size_binary ^5^ |
| large_utf8 | character |
| binary | arrow_binary ^3^ |
| large_binary | arrow_large_binary ^3^ |
| fixed_size_binary | arrow_fixed_size_binary ^3^ |
| date32 | Date |
| date64 | POSIXct |
| time32 | hms::difftime |
| time64 | hms::difftime |
| timestamp | POSIXct |
| duration | - |
| duration | -^2^ |
| decimal | double |
| dictionary | factor^4^ |
| list | arrow_list ^6^ |
| fixed_size_list | arrow_fixed_size_list ^6^ |
| list | arrow_list ^5^ |
| large_list | arrow_large_list ^5^ |
| fixed_size_list | arrow_fixed_size_list ^5^ |
| struct | data.frame |
| null | vctrs::vctrs_unspecified |
| map | - |
| union | - |
| large_utf8 | character |
| large_binary | arrow_large_binary ^5^ |
| large_list | arrow_large_list ^6^ |
| map | -^2^ |
| union | -^2^ |

^1^: These integer types may contain values that exceed the range of R's 
`integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are 
converted to `double` ("numeric") and `int64` is converted to 
`bit64::integer64`. This conversion can be disabled (so that `int64` always
yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.

^2^: Some Arrow data types do not currently have an R equivalent and will raise an error
if cast to or mapped to via a schema.
@jonkeanejonkeaneOct 5, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Might we mention something like "do not yet have an R equivalent"? At least for duration I imagine we will map it on to lubridate's duration type at some point?
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Sounds good
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Done

^3^: These integer types may contain values that exceed the range of R's `integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are converted to `double` ("numeric") and `int64` is converted to `bit64::integer64`. This conversion can be disabled (so that `int64` always yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.
^3^: `arrow*_binary` classes are implemented as lists of raw vectors. 

^4^: Due to the limitation of R `factor`s, Arrow `dictionary` values are coerced to string when translated to R if they are not already strings.
^4^: Due to the limitation of R factors, Arrow `dictionary` values are coerced
to string when translated to R if they are not already strings.
@jonkeanejonkeaneOct 5, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This isn't relevant in this doc, but now I'm curious: what is the limitation of R factors here?
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Not a clue tbh; I think @ianmcook may(?) have written this text originally, so might have a better idea than me

^5^: `arrow*_binary` classes are implemented as lists of raw vectors. 
^5^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` 
with a `ptype` attribute set to what an empty Array of the value type converts to. 

^6^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` with a `ptype` attribute set to what an empty Array of the value type converts to. 

### R object attributes

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-13397: [R] Update arrow.Rmd vignette by thisisnic · Pull Request #11202 · apache/arrow · GitHub
Skip to content
ARROW-13397: [R] Update arrow.Rmd vignette#11202

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

thisisnic
wants to merge
3
commits into

from

 Closed


ARROW-13397: [R] Update arrow.Rmd vignette
#11202
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
1d52b74

Re-order conversion tables, restart numbering, add explanation of flo…


thisisnic Sep 21, 2021
c367f04

Remove extraneous reference


thisisnic Oct 4, 2021
2d90eef

add "currently"


thisisnic Oct 6, 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


65 changes: 42 additions & 23 deletions
r/vignettes/arrow.Rmd

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -125,22 +125,31 @@ In the tables, entries with a `-` are not currently implemented.
|--------------------------|------------|
| logical | boolean |
| integer | int32 |
| double ("numeric") | float64 |
| character | utf8^1^ |
| double ("numeric") | float64^1^ |
| character | utf8^2^ |
| factor | dictionary |
| raw | uint8 |
| Date | date32 |
| POSIXct | timestamp |
| POSIXlt | struct |
| data.frame | struct |
| list^2^ | list |
| list^3^ | list |
| bit64::integer64 | int64 |
| difftime | time32 |
| vctrs::vctrs_unspecified | null |

^1^: If the character vector exceeds 2GB of strings, it will be converted to a `large_utf8` Arrow type

^2^: Only lists where all elements are the same type are able to be translated to Arrow list type (which is a "list of" some type).

^1^: `float64` and `double` are the same concept and data type in Arrow C++; 
however, only `float64()` is used in arrow as the function `double()` already 
exists in base R

^2^: If the character vector exceeds 2GB of strings, it will be converted to a 
`large_utf8` Arrow type

^3^: Only lists where all elements are the same type are able to be translated 
to Arrow list type (which is a "list of" some type).


### Arrow to R

Expand All@@ -150,42 +159,52 @@ In the tables, entries with a `-` are not currently implemented.
| int8 | integer |
| int16 | integer |
| int32 | integer |
| int64 | integer^3^ |
| int64 | integer^1^ |
| uint8 | integer |
| uint16 | integer |
| uint32 | integer^3^ |
| uint64 | integer^3^ |
| float16 | - |
| uint32 | integer^1^ |
| uint64 | integer^1^ |
| float16 | -^2^ |
| float32 | double |
| float64 | double |
| utf8 | character |
| binary | arrow_binary ^5^ |
| fixed_size_binary | arrow_fixed_size_binary ^5^ |
| large_utf8 | character |
| binary | arrow_binary ^3^ |
| large_binary | arrow_large_binary ^3^ |
| fixed_size_binary | arrow_fixed_size_binary ^3^ |
| date32 | Date |
| date64 | POSIXct |
| time32 | hms::difftime |
| time64 | hms::difftime |
| timestamp | POSIXct |
| duration | - |
| duration | -^2^ |
| decimal | double |
| dictionary | factor^4^ |
| list | arrow_list ^6^ |
| fixed_size_list | arrow_fixed_size_list ^6^ |
| list | arrow_list ^5^ |
| large_list | arrow_large_list ^5^ |
| fixed_size_list | arrow_fixed_size_list ^5^ |
| struct | data.frame |
| null | vctrs::vctrs_unspecified |
| map | - |
| union | - |
| large_utf8 | character |
| large_binary | arrow_large_binary ^5^ |
| large_list | arrow_large_list ^6^ |
| map | -^2^ |
| union | -^2^ |

^1^: These integer types may contain values that exceed the range of R's 
`integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are 
converted to `double` ("numeric") and `int64` is converted to 
`bit64::integer64`. This conversion can be disabled (so that `int64` always
yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.

^2^: Some Arrow data types do not currently have an R equivalent and will raise an error
if cast to or mapped to via a schema.
@jonkeanejonkeaneOct 5, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Might we mention something like "do not yet have an R equivalent"? At least for duration I imagine we will map it on to lubridate's duration type at some point?
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Sounds good
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Done

^3^: These integer types may contain values that exceed the range of R's `integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are converted to `double` ("numeric") and `int64` is converted to `bit64::integer64`. This conversion can be disabled (so that `int64` always yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.
^3^: `arrow*_binary` classes are implemented as lists of raw vectors. 

^4^: Due to the limitation of R `factor`s, Arrow `dictionary` values are coerced to string when translated to R if they are not already strings.
^4^: Due to the limitation of R factors, Arrow `dictionary` values are coerced
to string when translated to R if they are not already strings.
@jonkeanejonkeaneOct 5, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This isn't relevant in this doc, but now I'm curious: what is the limitation of R factors here?
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Not a clue tbh; I think @ianmcook may(?) have written this text originally, so might have a better idea than me

^5^: `arrow*_binary` classes are implemented as lists of raw vectors. 
^5^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` 
with a `ptype` attribute set to what an empty Array of the value type converts to. 

^6^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` with a `ptype` attribute set to what an empty Array of the value type converts to. 

### R object attributes

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-13397: [R] Update arrow.Rmd vignette by thisisnic · Pull Request #11202 · apache/arrow · GitHub
Skip to content
ARROW-13397: [R] Update arrow.Rmd vignette#11202

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

thisisnic
wants to merge
3
commits into

from

 Closed


ARROW-13397: [R] Update arrow.Rmd vignette
#11202
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
1d52b74

Re-order conversion tables, restart numbering, add explanation of flo…


thisisnic Sep 21, 2021
c367f04

Remove extraneous reference


thisisnic Oct 4, 2021
2d90eef

add "currently"


thisisnic Oct 6, 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


65 changes: 42 additions & 23 deletions
r/vignettes/arrow.Rmd

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -125,22 +125,31 @@ In the tables, entries with a `-` are not currently implemented.
|--------------------------|------------|
| logical | boolean |
| integer | int32 |
| double ("numeric") | float64 |
| character | utf8^1^ |
| double ("numeric") | float64^1^ |
| character | utf8^2^ |
| factor | dictionary |
| raw | uint8 |
| Date | date32 |
| POSIXct | timestamp |
| POSIXlt | struct |
| data.frame | struct |
| list^2^ | list |
| list^3^ | list |
| bit64::integer64 | int64 |
| difftime | time32 |
| vctrs::vctrs_unspecified | null |

^1^: If the character vector exceeds 2GB of strings, it will be converted to a `large_utf8` Arrow type

^2^: Only lists where all elements are the same type are able to be translated to Arrow list type (which is a "list of" some type).

^1^: `float64` and `double` are the same concept and data type in Arrow C++; 
however, only `float64()` is used in arrow as the function `double()` already 
exists in base R

^2^: If the character vector exceeds 2GB of strings, it will be converted to a 
`large_utf8` Arrow type

^3^: Only lists where all elements are the same type are able to be translated 
to Arrow list type (which is a "list of" some type).


### Arrow to R

Expand All@@ -150,42 +159,52 @@ In the tables, entries with a `-` are not currently implemented.
| int8 | integer |
| int16 | integer |
| int32 | integer |
| int64 | integer^3^ |
| int64 | integer^1^ |
| uint8 | integer |
| uint16 | integer |
| uint32 | integer^3^ |
| uint64 | integer^3^ |
| float16 | - |
| uint32 | integer^1^ |
| uint64 | integer^1^ |
| float16 | -^2^ |
| float32 | double |
| float64 | double |
| utf8 | character |
| binary | arrow_binary ^5^ |
| fixed_size_binary | arrow_fixed_size_binary ^5^ |
| large_utf8 | character |
| binary | arrow_binary ^3^ |
| large_binary | arrow_large_binary ^3^ |
| fixed_size_binary | arrow_fixed_size_binary ^3^ |
| date32 | Date |
| date64 | POSIXct |
| time32 | hms::difftime |
| time64 | hms::difftime |
| timestamp | POSIXct |
| duration | - |
| duration | -^2^ |
| decimal | double |
| dictionary | factor^4^ |
| list | arrow_list ^6^ |
| fixed_size_list | arrow_fixed_size_list ^6^ |
| list | arrow_list ^5^ |
| large_list | arrow_large_list ^5^ |
| fixed_size_list | arrow_fixed_size_list ^5^ |
| struct | data.frame |
| null | vctrs::vctrs_unspecified |
| map | - |
| union | - |
| large_utf8 | character |
| large_binary | arrow_large_binary ^5^ |
| large_list | arrow_large_list ^6^ |
| map | -^2^ |
| union | -^2^ |

^1^: These integer types may contain values that exceed the range of R's 
`integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are 
converted to `double` ("numeric") and `int64` is converted to 
`bit64::integer64`. This conversion can be disabled (so that `int64` always
yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.

^2^: Some Arrow data types do not currently have an R equivalent and will raise an error
if cast to or mapped to via a schema.
@jonkeanejonkeaneOct 5, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Might we mention something like "do not yet have an R equivalent"? At least for duration I imagine we will map it on to lubridate's duration type at some point?
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Sounds good
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Done

^3^: These integer types may contain values that exceed the range of R's `integer` type (32-bit signed integer). When they do, `uint32` and `uint64` are converted to `double` ("numeric") and `int64` is converted to `bit64::integer64`. This conversion can be disabled (so that `int64` always yields a `bit64::integer64` vector) by setting `options(arrow.int64_downcast = FALSE)`.
^3^: `arrow*_binary` classes are implemented as lists of raw vectors. 

^4^: Due to the limitation of R `factor`s, Arrow `dictionary` values are coerced to string when translated to R if they are not already strings.
^4^: Due to the limitation of R factors, Arrow `dictionary` values are coerced
to string when translated to R if they are not already strings.
@jonkeanejonkeaneOct 5, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This isn't relevant in this doc, but now I'm curious: what is the limitation of R factors here?
@thisisnicthisisnicOct 6, 2021

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Not a clue tbh; I think @ianmcook may(?) have written this text originally, so might have a better idea than me

^5^: `arrow*_binary` classes are implemented as lists of raw vectors. 
^5^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` 
with a `ptype` attribute set to what an empty Array of the value type converts to. 

^6^: `arrow*_list` classes are implemented as subclasses of `vctrs_list_of` with a `ptype` attribute set to what an empty Array of the value type converts to. 

### R object attributes

Expand Down