You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@arrow.apache.org by "Ian Cook (Jira)" <ji...@apache.org> on 2021/02/02 23:14:00 UTC
[jira] [Updated] (ARROW-11477) [R][Doc] Reorganize and improve
README and vignette content
[ https://issues.apache.org/jira/browse/ARROW-11477?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Ian Cook updated ARROW-11477:
-----------------------------
Description:
Collecting various ideas here for general ways to improve the R package README and vignettes for the 4.0.0 release:
* Consider moving the "building" and "developing" content out of the REAMDE and into a vignette focused on that topic. (Rationale: most users of the R package today are downloading prebuilt binaries, not building their own; most users today are end users, not developers; a more valuable use for the README—especially since that it's the homepage of the R docs site—would be as a place to highlight key capabilities of the package, not to show folks all the technical details of building it.)
* Get the "Using the Arrow C++ Library in R" vignette to show in the Articles menu on the R docs site.
* Edit the "Working with Arrow Datasets and dplyr" vignette to make clear that dplyr verbs can be used with Arrow Tables and RecordBatches (not just Datasets) and describe differences in dplyr support for these different Arrow objects.
* Check all the links in the "Project docs" menu on the docs site; some of them are currently broken or go to directory listings
was:
Collecting various ideas here for general ways to improve the R package README and vignettes for the 4.0.0 release:
* Consider moving the "building" and "developing" content out of the REAMDE and into a vignette focused on that topic. (Rationale: most users of the R package today are downloading prebuilt binaries, not building their own; most users today are end users, not developers; a more valuable use for the README—especially since that it's the homepage of the R docs site—would be as a place to highlight key capabilities of the package, not to show folks all the technical details of building it.)
* Get the "Using the Arrow C++ Library in R" vignette to show in the Articles menu on the R docs site.
* Edit the "Working with Arrow Datasets and dplyr" vignette to make clear that dplyr verbs can be used with Arrow Tables and RecordBatches (not just Datasets) and describe differences in dplyr support for these different Arrow objects.
> [R][Doc] Reorganize and improve README and vignette content
> -----------------------------------------------------------
>
> Key: ARROW-11477
> URL: https://issues.apache.org/jira/browse/ARROW-11477
> Project: Apache Arrow
> Issue Type: Improvement
> Components: Documentation, R
> Affects Versions: 3.0.0
> Reporter: Ian Cook
> Assignee: Ian Cook
> Priority: Major
> Fix For: 4.0.0
>
>
> Collecting various ideas here for general ways to improve the R package README and vignettes for the 4.0.0 release:
> * Consider moving the "building" and "developing" content out of the REAMDE and into a vignette focused on that topic. (Rationale: most users of the R package today are downloading prebuilt binaries, not building their own; most users today are end users, not developers; a more valuable use for the README—especially since that it's the homepage of the R docs site—would be as a place to highlight key capabilities of the package, not to show folks all the technical details of building it.)
> * Get the "Using the Arrow C++ Library in R" vignette to show in the Articles menu on the R docs site.
> * Edit the "Working with Arrow Datasets and dplyr" vignette to make clear that dplyr verbs can be used with Arrow Tables and RecordBatches (not just Datasets) and describe differences in dplyr support for these different Arrow objects.
> * Check all the links in the "Project docs" menu on the docs site; some of them are currently broken or go to directory listings
--
This message was sent by Atlassian Jira
(v8.3.4#803005)