rcpp-gallery icon indicating copy to clipboard operation
rcpp-gallery copied to clipboard

Update R package requirements in "Local Development Configuration" wiki

Open ArtemSokolov opened this issue 5 years ago • 9 comments

After performing a local build, I noticed that the following R packages were required, but not specified on the "Local Development Configuration" wiki:

Furthermore, the benchmark package listed in the dependencies seems to be archived on CRAN.

Lastly, I think it might be nice to give wiki readers an install.packages() line they can copy to their R environment, similar to what's provided with the sudo apt-get install ... lines. Consider including something like

install.packages( c("Rcpp", "RcppEigen", ...) )
devtools::install_github( "RcppCore/RcppNT2" )
devtools::install_github( "dcdillon/RcppHoney" )

ArtemSokolov avatar Jan 03 '20 16:01 ArtemSokolov

Yes. There is potentially a lot more on a per-post basis, depending on whether you want to recreate the posts. (I have been noodling with a pdf variant ...)

The benchmark is a typo. I meant rbenchmark.

I guess we could clean this up but I am not sure how high a priority it is. Thoughts, @jjallaire ?

eddelbuettel avatar Jan 03 '20 16:01 eddelbuettel

Not something I have time for right now but definitely worthwhile!

On Fri, Jan 3, 2020 at 11:18 AM Dirk Eddelbuettel [email protected] wrote:

Yes. There is potentially a lot more on a per-post basis, depending on whether you want to recreate the posts. (I have been noodling with a pdf variant ...)

The benchmark is a typo. I meant rbenchmark https://cran.r-project.org/package=rbenchmark.

I guess we could clean this up but I am not sure how high a priority it is. Thoughts, @jjallaire https://github.com/jjallaire ?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/RcppCore/rcpp-gallery/issues/121?email_source=notifications&email_token=AAAZPR5RWHHYP2N37KPNSETQ35QMJA5CNFSM4KCPFIAKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEIBPQVY#issuecomment-570619991, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAZPR6KSISACM3SAYDGQTDQ35QMJANCNFSM4KCPFIAA .

jjallaire avatar Jan 03 '20 18:01 jjallaire

Maybe the simplest fix would be to ... update the wiki page?

@ArtemSokolov as you have fresh eyes for the topic would you want to take a stab at it?

eddelbuettel avatar Jan 04 '20 23:01 eddelbuettel

Honestly, other than the R package dependencies, I think the wiki page is in a pretty good shape! I'm happy to make the changes I proposed, but I don't think GitHub has an easy way to submit a pull request for wiki pages.

Let me know how you would like to proceed.

ArtemSokolov avatar Jan 05 '20 21:01 ArtemSokolov

Yes, the wiki pages are often left behind. I think one ... just edits as on any other wiki but storage is in git so one could roll-up if the need arose.

eddelbuettel avatar Jan 05 '20 21:01 eddelbuettel

I think there's a permission control somewhere. Currently, there is no edit option visible to me in the Wiki tab.

ArtemSokolov avatar Jan 06 '20 16:01 ArtemSokolov

Hm. Do you see the Clone this wiki locally on the right side when you are on a post?

eddelbuettel avatar Jan 06 '20 16:01 eddelbuettel

Yes. However, as discussed in this blog post, "while you can clone the wiki and make a change to your copy, you cannot submit a pull request as your copy is not “linked” with the original repository."

So, we just need to figure out an effective way to get any changes I make to appear in this primary fork.

ArtemSokolov avatar Jan 06 '20 22:01 ArtemSokolov

Maybe make the changes and email me a diff? I don't have time to dig now if there is mode somewhere between wiki 'locked and open to owners' and 'open to rest of world'.

eddelbuettel avatar Jan 06 '20 22:01 eddelbuettel