Skip to content

Commit

Permalink
Merge pull request #1078 from RcppCore/feature/library_vignette
Browse files Browse the repository at this point in the history
Add new vignette about packaging C++ libraries (closes #1077)
  • Loading branch information
eddelbuettel authored May 1, 2020
2 parents 6ae0ab4 + 754a492 commit 95d0854
Show file tree
Hide file tree
Showing 9 changed files with 914 additions and 399 deletions.
789 changes: 399 additions & 390 deletions ChangeLog

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: Rcpp
Title: Seamless R and C++ Integration
Version: 1.0.4.9
Date: 2020-04-26
Version: 1.0.4.10
Date: 2020-04-30
Author: Dirk Eddelbuettel, Romain Francois, JJ Allaire, Kevin Ushey, Qiang Kou,
Nathan Russell, Douglas Bates and John Chambers
Maintainer: Dirk Eddelbuettel <edd@debian.org>
Expand Down
4 changes: 3 additions & 1 deletion inst/NEWS.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@
\item Changes in Rcpp Documentation:
\itemize{
\item The pdf file of the earlier introduction is again typeset
with bibliographic information. (Dirk)
with bibliographic information (Dirk).
\item A new vignette describing how to package C++ libraries has
been added (Dirk in \ghpr{1078} fixing \ghit{1077}).
}
\item Changes in Rcpp Deployment:
\itemize{
Expand Down
53 changes: 51 additions & 2 deletions inst/bib/Rcpp.bib
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,15 @@ @Misc{Brokken:2011:Cpp
url = {http://www.icce.rug.nl/documents/cplusplus/}
}

@Manual{CRAN:BH,
title = {BH: Boost C++ Header Files},
author = {Dirk Eddelbuettel and John W. Emerson and Michael
J. Kane},
year = {2019},
note = {R package version 1.69.0-1},
url = {https://CRAN.R-project.org/package=BH},
}

@Manual{CRAN:Matrix,
title = {\pkg{Matrix}: Sparse and Dense Matrix Classes and Methods},
author = {Douglas Bates and Martin Maechler},
Expand Down Expand Up @@ -299,6 +308,15 @@ @Manual{CRAN:minqa
url = CRAN # "package=minqa"
}

@Manual{CRAN:pkgKitten,
title = {pkgKitten: Create Simple Packages Which Do not Upset
R Package Checks},
author = {Dirk Eddelbuettel},
year = {2019},
note = {R package version 0.1.5},
url = CRAN # "package=pkgKitten"
}

@Manual{CRAN:profvis,
title = {profvis: Interactive Visualizations for Profiling R Code},
author = {Winston Chang and Javier Luraschi},
Expand Down Expand Up @@ -412,6 +430,8 @@ @Book{Eddelbuettel:2013:Rcpp
address = {New York},
isbn = {978-1-4614-6867-7}
}
; see http://eigen.tuxfamily.org/index.php?title=BibTeX
; replaced 'howpublished' with 'url' and updated year to 2011, and again to 2012
@article{Efron:1979:Bootstrap,
URL = {http://www.jstor.org/stable/2958830},
Expand All @@ -430,9 +450,9 @@ @MISC{Eigen:Web
title = {Eigen v3},
year = 2012,
url = {http://eigen.tuxfamily.org},
; see http://eigen.tuxfamily.org/index.php?title=BibTeX
; replaced 'howpublished' with 'url' and updated year to 2011, and again to 2012
}
; see http://eigen.tuxfamily.org/index.php?title=BibTeX
; replaced 'howpublished' with 'url' and updated year to 2011, and again to 2012

@Manual{GSL,
title = {{GNU} {S}cientific {L}ibrary {R}eference {M}anual},
Expand Down Expand Up @@ -836,6 +856,7 @@ @inproceedings{Veldhuizen:1998:Blitz
address = {London},
}


@Book{Venables+Ripley:2000:SProgramming,
author = {Willian N. Venables and Brian D. Ripley},
title = {S Programming},
Expand All @@ -845,6 +866,7 @@ @Book{Venables+Ripley:2000:SProgramming
address = {New York}
}


@Book{Venables+Ripley:2002:MASS,
title = {Modern Applied Statistics with S},
author = {W. N. Venables and B. D. Ripley},
Expand All @@ -855,3 +877,30 @@ @Book{Venables+Ripley:2002:MASS
note = {ISBN 0-387-95457-0},
url = {http://www.stats.ox.ac.uk/pub/MASS4},
}

@misc{arxiv:corels,
title = {Learning Certifiably Optimal Rule Lists for
Categorical Data},
author = {Elaine Angelino and Nicholas Larus-Stone and Daniel
Alabi and Margo Seltzer and Cynthia Rudin},
year = 2017,
howpublished = {\href{http://www.arxiv.org/1704.01701}{arXiv:1704.01701}},
archivePrefix ={arXiv},
primaryClass = {stat.ML}
}

@Misc{github:corels,
author = {Nicholas Laurus-Stone},
title = {corels: {Learning Certifiably Optimal Rule Lists}},
howpublished = {\url{https://github.com/nlarusstone/corels}. Also online at \url{https://corels.eecs.harvard.edu/corels/}},
month = 06,
year = 2019
}

@Misc{github:rcppcorels,
author = {Dirk Eddelbuettel},
title = {RcppCorels: R binding for the 'Certifiably Optimal RulE ListS (Corels)' Learner},
howpublished = {\url{https://github.com/eddelbuettel/rcppcorels}},
month = 11,
year = 2019
}
4 changes: 2 additions & 2 deletions inst/include/Rcpp/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
#define RCPP_VERSION_STRING "1.0.4"

// the current source snapshot
#define RCPP_DEV_VERSION RcppDevVersion(1,0,4,9)
#define RCPP_DEV_VERSION_STRING "1.0.4.9"
#define RCPP_DEV_VERSION RcppDevVersion(1,0,4,10)
#define RCPP_DEV_VERSION_STRING "1.0.4.10"

#endif
2 changes: 2 additions & 0 deletions vignettes/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ rnwsources = Rcpp-attributes.Rnw \
Rcpp-FAQ.Rnw \
Rcpp-introduction.Rnw \
Rcpp-jss-2011.Rnw \
Rcpp-libraries.Rnw \
Rcpp-modules.Rnw \
Rcpp-package.Rnw \
Rcpp-quickref.Rnw \
Expand All @@ -20,6 +21,7 @@ rnwvignettes = Rcpp-attributes.pdf \
Rcpp-FAQ.pdf \
Rcpp-introduction.pdf \
Rcpp-jss-2011.pdf \
Rcpp-libraries.pdf \
Rcpp-modules.pdf \
Rcpp-package.pdf \
Rcpp-quickref.pdf \
Expand Down
10 changes: 10 additions & 0 deletions vignettes/Rcpp-libraries.Rnw
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
\documentclass{article}
\usepackage{pdfpages}
%\VignetteIndexEntry{Rcpp-libraries}
%\VignetteKeywords{Rcpp, Package, Library}
%\VignettePackage{Rcpp}
%\VignetteEncoding{UTF-8}

\begin{document}
\includepdf[pages=-, fitpaper=true]{pdf/Rcpp-libraries.pdf}
\end{document}
Loading

0 comments on commit 95d0854

Please sign in to comment.