Uploaded image for project: 'Apache Arrow'
  1. Apache Arrow
  2. ARROW-11477

[R][Doc] Reorganize and improve README and vignette content

    XMLWordPrintableJSON

    Details

      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

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                icook Ian Cook
                Reporter:
                icook Ian Cook
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 7h 20m
                  7h 20m