search

RcppCore / rcpp-gallery

Source code for the Rcpp Gallery website
http://gallery.rcpp.org
Other
69 stars 71 forks source link

New vignette highlighting the usage of Roxygen2 in Rcpp packages #120

Closed ArtemSokolov closed 4 years ago

ArtemSokolov commented 4 years ago

Hi Dirk,

Happy New Year! Per your earlier request, I am submitting a vignette that expands on my example of documenting Rcpp functions and classes with Roxygen2.

I did a local build, and everything seems to look OK. Please let me know if anything needs to be changed.

Best, -Artem

eddelbuettel commented 4 years ago

Fantastic -- will review this weekend!

ArtemSokolov commented 4 years ago

Thanks for the feedback, Dirk. Yes, happy to have the vignette use Rcpp.package.skeleton() in place of devtools/usethis; keeping the number of dependencies to a minimum is always a good idea.

I'll push additional edits later this week to address individual comments, but feel free to begin the Rcpp.package.skeleton() revision if you have time.

eddelbuettel commented 4 years ago

Sounds good on both counts.

I actually think we should take the Rcpp.package.skeleton() vs vai Rtudio menu vs devtools vs usethis into a different vignette: "ways to create a package" and/or "ways compile/link/load - cycle a package". What do you think?

ArtemSokolov commented 4 years ago

Yes, great idea! I think having a package-centric vignette will be very helpful.

eddelbuettel commented 4 years ago

Will merge and edit post-merge. Let's consider it work-in-progress for a few days :)

eddelbuettel commented 4 years ago

Merged, made some small edits and pushed. Hope you're ok with what I added, if not we can always discuss / revert ...