Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

ARROW-14280: [Doc] R package Architectural Overview #14294

Merged
merged 7 commits into from
Oct 13, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
19 changes: 17 additions & 2 deletions docs/source/developers/guide/architectural_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,20 @@ For an Architectural Overview of Arrow's libraries please
refer to:

- :ref:`py_arch_overview`
- R package Architectural Overview (in progress, see
`issue ARROW-14280 <https://issues.apache.org/jira/browse/ARROW-14280>`_)
- R package Architecture can be found on this page.


R package Architectural Overview
--------------------------------

.. figure:: /developers/images/R_architectural_overview.png
:alt: Main parts of R package architecture: dplyr-*,
dplyr-funcs*, tools, tests and src/.

* The ``r/R/dplyr-*`` files define the verbs used in a regular
dplyr syntax on Arrow objects.
* The ``r/R/dplyr-funcs*`` files define bindings to Arrow C++
functions that can be used with already defined dplyr verbs.
* All the C++ code connected to the R package lives in ``arrow/r/src``.
It also includes C++ code which connects libarrow (the Arrow C++
library) and the R code in package.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.