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

Conversation

AlenkaF
Copy link
Member

@AlenkaF AlenkaF commented Oct 3, 2022

This PR adds an architectural overview of the R package to the New Contributor's Guide.

This work is co-authored by @thisisnic .

Screenshot 2022-10-03 at 15 09 23

@github-actions
Copy link

github-actions bot commented Oct 3, 2022

@github-actions
Copy link

github-actions bot commented Oct 3, 2022

⚠️ Ticket has not been started in JIRA, please click 'Start Progress'.

@AlenkaF
Copy link
Member Author

AlenkaF commented Oct 4, 2022

Mind having a look at this PR @jonkeane @thisisnic?
Wasn't sure if this should go to the R dev docs or in the New Contributor's Guide.

Copy link
Member

@jonkeane jonkeane left a comment

Choose a reason for hiding this comment

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

Thanks for this, this is really great. I'm fine keeping it where it is, but it would be nice to link to it in our developers guide section somewhere too.

The only other thing that I might add is:

  • When distributing a source package, we frequently bundle the libarrow source in a directory tools/cpp

    arrow/r/Makefile

    Lines 43 to 49 in 797f770

    sync-cpp:
    cp ../NOTICE.txt inst/NOTICE.txt
    rsync --archive --delete --exclude 'apidoc' --exclude 'build' --exclude 'build-support/boost_*' --exclude 'examples' --exclude 'src/gandiva' --exclude 'src/jni' --exclude 'src/plasma' --exclude 'src/skyhook' --exclude 'submodules' --exclude '**/*_test.cc' ../cpp tools/
    cp -p ../.env tools/dotenv
    cp -p ../NOTICE.txt tools/
    cp -p ../LICENSE.txt tools/
    sed -i"" -e "s/\.env/dotenv/g" tools/cpp/CMakeLists.txt
    for a part of the makefile that does that.
  • Do we want to mention anything about the man directory with documentation (and that it shouldn't be updated directly?)
  • Do we want to mention anything about the vignettes directory?

@AlenkaF
Copy link
Member Author

AlenkaF commented Oct 4, 2022

+1 @jonkeane, thank you! Will include suggested and ping when I am done 🙏

@AlenkaF
Copy link
Member Author

AlenkaF commented Oct 11, 2022

@jonkeane I think I have addressed all of you comments and the PR should be ready for another round of review.

Copy link
Member

@jonkeane jonkeane left a comment

Choose a reason for hiding this comment

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

Love this! Thank you so much

Co-authored-by: Jonathan Keane <jkeane@gmail.com>
@AlenkaF
Copy link
Member Author

AlenkaF commented Oct 11, 2022

@thisisnic would be great to have your final review also 🙏

Copy link
Member

@thisisnic thisisnic left a comment

Choose a reason for hiding this comment

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

LGTM!

@AlenkaF AlenkaF merged commit 6d815a4 into apache:master Oct 13, 2022
@AlenkaF AlenkaF deleted the ARROW-14280 branch October 13, 2022 11:29
@ursabot
Copy link

ursabot commented Oct 14, 2022

Benchmark runs are scheduled for baseline = 02c671a and contender = 6d815a4. 6d815a4 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2
[Failed ⬇️0.0% ⬆️0.0%] test-mac-arm
[Failed ⬇️0.27% ⬆️0.0%] ursa-i9-9960x
[Finished ⬇️0.14% ⬆️0.04%] ursa-thinkcentre-m75q
Buildkite builds:
[Finished] 6d815a4d ec2-t3-xlarge-us-east-2
[Failed] 6d815a4d test-mac-arm
[Failed] 6d815a4d ursa-i9-9960x
[Finished] 6d815a4d ursa-thinkcentre-m75q
[Finished] 02c671a3 ec2-t3-xlarge-us-east-2
[Failed] 02c671a3 test-mac-arm
[Failed] 02c671a3 ursa-i9-9960x
[Finished] 02c671a3 ursa-thinkcentre-m75q
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants