Skip to content

ARROW-3943: [R] vignette - #3107

Closed
romainfrancois wants to merge 11 commits into
apache:masterfrom
romainfrancois:vignette
Closed

ARROW-3943: [R] vignette#3107
romainfrancois wants to merge 11 commits into
apache:masterfrom
romainfrancois:vignette

Conversation

@romainfrancois

Copy link
Copy Markdown
Contributor

No description provided.

@romainfrancoisromainfrancois added WIP PR is work in progress Component: R labels Dec 5, 2018
@xhochy

Copy link
Copy Markdown
Member

@romainfrancois I wondering whether we could combine this into the general Sphinx documentation. We are currently merging the Python and C++ infrastructure with the general Arrow format documentation over at #2856

Disclaimer: As I'm not an R expert, I have no idea how well this plays with the R ecosystem.

@romainfrancois

Copy link
Copy Markdown
ContributorAuthor

Could be interesting. I have the opposite disclaimer though.

@xhochy

Copy link
Copy Markdown
Member

@wesm As you know both worlds, can you help us here?

@wesm

wesm commented Dec 5, 2018

Copy link
Copy Markdown
Member

It's customary to include a vignette with CRAN packages. See https://cran.r-project.org/web/packages/dplyr/index.html. So even if we publish this on arrow.apache.org, we still would probably need to have a vignette.

@xhochy

Copy link
Copy Markdown
Member

So a vignette is a something between a TL;DR paragraph and the fully fledged package documentation? This means we would probably have the vignette and would write a fully featured documentation somewhere else? That sounds good to me.

@wesm

wesm commented Dec 5, 2018

Copy link
Copy Markdown
Member

Right, the vignette is something akin to a "getting started" guide

@codecov-io

codecov-io commented Dec 10, 2018

Copy link
Copy Markdown

Codecov Report

Merging #3107 into master will decrease coverage by 20.04%.
The diff coverage is n/a.

Impacted file tree graph

@@ Coverage Diff @@## master #3107 +/- ##
===========================================
- Coverage 87.78% 67.73% -20.05% 
===========================================
Files 710 410 -300 Lines 86837 54672 -32165 Branches 1252 1252 ===========================================
- Hits 76226 37034 -39192 - Misses 10498 17630 +7132 + Partials 113 8 -105
Impacted FilesCoverage Δ
cpp/src/arrow/extension_type.h0% <0%> (-100%)⬇️
cpp/src/parquet/hasher.h0% <0%> (-100%)⬇️
cpp/src/arrow/io/hdfs-internal.h0% <0%> (-100%)⬇️
cpp/src/arrow/util/sse-util.h0% <0%> (-100%)⬇️
cpp/src/arrow/testing/random.h0% <0%> (-100%)⬇️
cpp/src/arrow/pretty_print.h0% <0%> (-100%)⬇️
cpp/src/parquet/murmur3.h0% <0%> (-100%)⬇️
cpp/src/arrow/testing/util.h0% <0%> (-100%)⬇️
cpp/src/arrow/util/int-util.cc0.39% <0%> (-99.21%)⬇️
cpp/src/arrow/ipc/json-simple.cc0.41% <0%> (-98.76%)⬇️
... and 461 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8070d65...206f759. Read the comment docs.

mrknand others added 10 commits March 28, 2019 10:43
I encounter the following build error when I built the tarball of 0.13.0 RC.
```
[38/597] Performing configure step for 'grpc_ep'
FAILED: grpc_ep-prefix/src/grpc_ep-stamp/grpc_ep-configure
cd /Users/mrkn/Downloads/apache-arrow-0.13.0/cpp/build/grpc_ep-prefix/src/grpc_ep-build && /opt/brew/Cellar/cmake/3.13.3/bin/cmake -P /Users/mrkn/Downloads/apache-arrow-0.13.0/cpp/build/grpc_ep-prefix/src/grpc_ep-stamp/grpc_ep-configure-RELEASE.cmake && /opt/brew/Cellar/c
make/3.13.3/bin/cmake -E touch /Users/mrkn/Downloads/apache-arrow-0.13.0/cpp/build/grpc_ep-prefix/src/grpc_ep-stamp/grpc_ep-configure
CMake Error at /Users/mrkn/Downloads/apache-arrow-0.13.0/cpp/build/grpc_ep-prefix/src/grpc_ep-stamp/grpc_ep-configure-RELEASE.cmake:16 (message):
Command failed: 1
'/opt/brew/Cellar/cmake/3.13.3/bin/cmake' '-DCMAKE_BUILD_TYPE=RELEASE' '-DCMAKE_PREFIX_PATH=';/opt/brew;/Users/mrkn/src/github.com/apache/arrow/cpp/build/gflags_ep-prefix/src/gflags_ep;/Users/mrkn/Downloads/apache-arrow-0.13.0/cpp/thirdparty/cares_ep-install;'' '-DgRPC
_CARES_PROVIDER=package' '-DgRPC_GFLAGS_PROVIDER=package' '-DgRPC_PROTOBUF_PROVIDER=package' '-DgRPC_SSL_PROVIDER=package' '-DgRPC_ZLIB_PROVIDER=package' '-DCMAKE_CXX_FLAGS= -Qunused-arguments -fcolor-diagnostics -O3 -DNDEBUG -O3 -DNDEBUG -fPIC' '-DCMAKE_C_FLAGS= -Qunused-arguments -O3 -DNDEBUG -O3 -DNDEBUG -fPIC' '-DCMAKE_INSTALL_PREFIX=/Users/mrkn/Downloads/apache-arrow-0.13.0/cpp/thirdparty/grpc_ep-install' '-DCMAKE_INSTALL_LIBDIR=lib' '-DProtobuf_PROTOC_LIBRARY=/opt/brew/lib/libprotoc.dylib' '-DBUILD_SHARED_LIBS=OFF' '-GNinja' '/Users/mrkn/Downloads/apache-arrow-0.13.0/cpp/build/grpc_ep-prefix/src/grpc_ep' See also /Users/mrkn/Downloads/apache-arrow-0.13.0/cpp/build/grpc_ep-prefix/src/grpc_ep-stamp/grpc_ep-configure-*.log
```
grpc_ep's build log is given below:
```
$ cat /Users/mrkn/Downloads/apache-arrow-0.13.0/cpp/build/grpc_ep-prefix/src/grpc_ep-stamp/grpc_ep-configure-*.log
CMake Error at cmake/cares.cmake:38 (find_package):
Could not find a package configuration file provided by "c-ares" with any
of the following names:
c-aresConfig.cmake
c-ares-config.cmake
Add the installation prefix of "c-ares" to CMAKE_PREFIX_PATH or set
"c-ares_DIR" to a directory containing one of the above files. If "c-ares"
provides a separate development package or SDK, be sure it has been
installed.
Call Stack (most recent call first):
CMakeLists.txt:139 (include)
(snip)
```
This build log says that grpc_ep couldn't find cares_ep.
In this case, grpc_ep was built before cares_ep.
This pull-request could fix this dependency error on my environment.
Author: Kenta Murata <mrkn@mrkn.jp>
Closesapache#4064 from mrkn/cpp_grpc_depends_on_cares and squashes the following commits:
1a37054 <Kenta Murata> Specify dependencies of grpc_ep
Author: Kouhei Sutou <kou@clear-code.com>
Closesapache#4069 from kou/release-fix-typo-in-mail-template and squashes the following commits:
15dc3c8 <Kouhei Sutou> Fix typos in vote e-mail template
 * Use jq in local
* Ensure making variables for "for" function local for parallel processing
Author: Kouhei Sutou <kou@clear-code.com>
Closesapache#4070 from kou/release-improve-binary-upload-performance and squashes the following commits:
2463d3c <Kouhei Sutou> Improve 03-binary performance
@nealrichardson

Copy link
Copy Markdown
Member

This PR is stale and I think we should close it. The vignette content is a good start, and I'd be happy to help contribute to it on a new PR.

@wesmwesm closed this May 30, 2019
@romainfrancois
romainfrancois deleted the vignette branch June 6, 2019 14:33
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: RWIPPR is work in progress

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@romainfrancois@xhochy@wesm@codecov-io@nealrichardson@mrkn@kou