[Rcpp-commits] r2905 - in pkg/Rcpp: . inst inst/doc inst/doc/Rcpp-FAQ
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Sat Feb 19 19:21:32 CET 2011
Author: edd
Date: 2011-02-19 19:21:32 +0100 (Sat, 19 Feb 2011)
New Revision: 2905
Modified:
pkg/Rcpp/ChangeLog
pkg/Rcpp/inst/NEWS
pkg/Rcpp/inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw
pkg/Rcpp/inst/doc/Rcpp.bib
Log:
expanded Rcpp-FAQ with three more setup-related questions
rolled version in Rcpp.bib
Modified: pkg/Rcpp/ChangeLog
===================================================================
--- pkg/Rcpp/ChangeLog 2011-02-19 00:20:12 UTC (rev 2904)
+++ pkg/Rcpp/ChangeLog 2011-02-19 18:21:32 UTC (rev 2905)
@@ -1,3 +1,8 @@
+2011-02-19 Dirk Eddelbuettel <edd at debian.org>
+
+ * inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw: Added three more setup-related
+ questions in the first section following another rcpp-devel question
+
2011-02-14 Dirk Eddelbuettel <edd at debian.org>
* DESCRIPTION: Release 0.9.1
Modified: pkg/Rcpp/inst/NEWS
===================================================================
--- pkg/Rcpp/inst/NEWS 2011-02-19 00:20:12 UTC (rev 2904)
+++ pkg/Rcpp/inst/NEWS 2011-02-19 18:21:32 UTC (rev 2905)
@@ -1,3 +1,7 @@
+0.9.2 2011-0x-yz
+
+ o Three additional setup questions were added to the Rcpp-FAQ vignette
+
0.9.1 2011-02-14
o A number of internal changes to the memory allocation / protection of
Modified: pkg/Rcpp/inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw
===================================================================
--- pkg/Rcpp/inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw 2011-02-19 00:20:12 UTC (rev 2904)
+++ pkg/Rcpp/inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw 2011-02-19 18:21:32 UTC (rev 2905)
@@ -100,10 +100,73 @@
\subsection{How do I get started ?}
+Please execute the following command in \proglang{R}
+
<<eval=FALSE>>=
vignette( "Rcpp-introduction" )
@
+\noindent to access the vignette which provides a detailed introduction.
+
+\subsection{What do I need ?}
+
+Obviously, \proglang{R} must be installed. \pkg{Rcpp} provides a
+\proglang{C++} API as an extension to the \proglang{R} system. As such, it
+is bound by the choices made by \proglang{R} and is also influenced by how
+\proglang{R} is configured.
+
+In general, the standard environment for building a CRAN package from source
+(even when it contains \proglang{C} or \proglang{C++} code) is required. This
+means one needs:
+\begin{itemize}
+\item a development environment with a suitable compiler (see
+ below), header files and required libraries;
+\item \proglang{R} should be built in a way that permits linking and possibly
+ embedding of \proglang{R}; this is typically ensured by the
+ \texttt{--enable-shared-lib} option;
+\item standard development tools such as \texttt{make} etc.
+\end{itemize}
+
+
+\subsection{What compiler can I use?}
+
+On almost all platforms, the GNU Compiler Collection (or \texttt{gcc}, which
+is also the name of its \proglang{C} language compiler) has to be used along
+with the corresponding \texttt{g++} compiler for the \proglang{C++} language.
+A minimal suitable version is a final 4.2.* release; earlier 4.2.* were
+lacking some \proglang{C++} features. Generally speaking, and as of early
+2011, the default compilers on all the common platforms are suitable.
+
+Specific per-platform notes:
+\begin{description}
+ \item[Windows] users need the \texttt{Rtools} package from the site maintained by
+ Duncan Murdoch which contains all the required tools in a single package;
+ complete instructions specific to Windows are in the `R Administration'
+ manual \citep[Appendix D]{R:Administration}.
+ \item[OS X] users, as noted in the `R Administration' manual \citep[Appendix
+ C.4]{R:Administration}, need to install the Apple Developer Tools
+ (\textsl{e.g.}, \texttt{Xcode}) (as well as \texttt{gfortran} if \proglang{R} or
+ Fortran-using packages are to be built).
+ \item[Linux] user need to install the standard developement packages. Some
+ distributions provide helper packages which pull in all the required
+ packages; the \texttt{r-base-dev} package on Debian and Ubuntu is an example.
+\end{description}
+
+
+\subsection{What other packages are useful?}
+
+Additional packages that we have found useful are
+
+\begin{description}
+\item[\pkg{inline}] which is invaluable for direct compilation, linking and loading
+ of short code snippets, and used throughout this book too;
+\item[\pkg{RUnit}] is used for unit testing; the package is recommended and will be needed to re-run
+ some of our tests but it is not strictly required;
+\item[\pkg{rbenchmark}] to run simple timing comparisons and benchmarks; it is also
+ recommended but not required.
+\end{description}
+
+
\section{Compiling and Linking}
\subsection{How do I use \pkg{Rcpp} in my package ?}
Modified: pkg/Rcpp/inst/doc/Rcpp.bib
===================================================================
--- pkg/Rcpp/inst/doc/Rcpp.bib 2011-02-19 00:20:12 UTC (rev 2904)
+++ pkg/Rcpp/inst/doc/Rcpp.bib 2011-02-19 18:21:32 UTC (rev 2905)
@@ -85,8 +85,8 @@
@Manual{CRAN:Rcpp,
title = {Rcpp \proglang{R}/\proglang{C++} interface package},
author = {Dirk Eddelbuettel and Romain Fran\c{c}ois},
- year = 2010,
- note = {R package version 0.9.0},
+ year = 2011,
+ note = {R package version 0.9.1},
url = CRAN # "package=Rcpp"
}
@@ -96,7 +96,7 @@
author = {Romain Fran\c{c}ois and Dirk Eddelbuettel and
Douglas Bates},
year = 2011,
- note = {R package version 0.2.11},
+ note = {R package version 0.2.13},
url = CRAN # "package=RcppArmadillo"
}
@@ -108,6 +108,14 @@
url = CRAN # "package=RcppClassic"
}
+ at Manual{CRAN:RcppDE,
+ title = {RcppDE: Global optimization by differential evolution in C++},
+ author = {Dirk Eddelbuettel},
+ year = 2010,
+ note = {R package version 0.1.0},
+ url = CRAN # "package=RcppDE"
+}
+
@Manual{CRAN:RcppExamples,
title = {RcppExamples: Examples using {Rcpp} to interface {R}
and {C++}},
@@ -241,6 +249,15 @@
isbn = {978-0134376332},
}
+ at manual{R:Administration,
+ author = RCoreTeam,
+ organization = RFoundation,
+ address = {Vienna, Austria},
+ year = 2010,
+ title = "R Installation and Administration",
+ url = manuals # "R-admin.html"
+}
+
@manual{R:Extensions,
author = RCoreTeam,
organization = RFoundation,
More information about the Rcpp-commits
mailing list