[Rcpp-commits] r3777 - in pkg/RcppBDT: R man

[noreply at r-forge.r-project.org]

Author: edd
Date: 2012-09-22 19:10:39 +0200 (Sat, 22 Sep 2012)
New Revision: 3777

Modified:
   pkg/RcppBDT/R/zzz.R
   pkg/RcppBDT/man/RcppBDT-package.Rd
   pkg/RcppBDT/man/bdtDt.Rd
   pkg/RcppBDT/man/bdtPt.Rd
   pkg/RcppBDT/man/bdtTz.Rd
Log:
updates to manual pages


Modified: pkg/RcppBDT/R/zzz.R
===================================================================
--- pkg/RcppBDT/R/zzz.R	2012-09-22 17:02:33 UTC (rev 3776)
+++ pkg/RcppBDT/R/zzz.R	2012-09-22 17:10:39 UTC (rev 3777)
@@ -30,7 +30,6 @@
 ## }
 
 
-##loadModule("bdtMod", TRUE)
 loadModule("bdtDtMod", TRUE)
 loadModule("bdtTzMod", TRUE)
 loadModule("bdtDuMod", TRUE)
@@ -44,9 +43,6 @@
     x
 }) )
 
-.format_date <- function(x, ...) format(x$getDate(), ...)
-.show_date   <- function(object) print(object$getDate())
-
 .format_dt <- function(x, ...) format(x$getDate(), ...)
 .show_dt   <- function(object) print(object$getDate())
 

Modified: pkg/RcppBDT/man/RcppBDT-package.Rd
===================================================================
--- pkg/RcppBDT/man/RcppBDT-package.Rd	2012-09-22 17:02:33 UTC (rev 3776)
+++ pkg/RcppBDT/man/RcppBDT-package.Rd	2012-09-22 17:10:39 UTC (rev 3777)
@@ -7,7 +7,7 @@
   This package provides R with access to Boost Date_Time
   functonality by using Rcpp modules.
 
-  Currently only Date functionality is covered.
+  Date, Local time, duration and time zone functionality is covered.
 }
 \details{
   Please consult the Boost documentation for (copious) details on the

Modified: pkg/RcppBDT/man/bdtDt.Rd
===================================================================
--- pkg/RcppBDT/man/bdtDt.Rd	2012-09-22 17:02:33 UTC (rev 3776)
+++ pkg/RcppBDT/man/bdtDt.Rd	2012-09-22 17:10:39 UTC (rev 3777)
@@ -1,28 +1,29 @@
-\name{bdt}
+\name{bdtDt}
 \alias{bdt}
-\alias{bdtMod}
-\alias{show,Rcpp_bdtDate-method}
-\alias{format,Rcpp_bdtDate-method}
-\alias{bdtDate}
-\alias{Rcpp_bdtDate-class}
+\alias{bdtDt}
+\alias{show,Rcpp_bdtDt-method}
+\alias{format,Rcpp_bdtDt-method}
+\alias{Rcpp_bdtDt-class}
 \docType{package}
-\title{Default object for RcppBDT Boost Date_Time binding}
+\title{Rcpp module bdtDt for binding of Boost Date_Time Date functionality}
 \description{
-  The \verb{bdt} variable is a default instance of the 'date' class
-  created by means of Rcpp modules. It facilities accessing the member
-  functions via utility function, see for example \code{\link{getEndOfBizWeek}}.
+  The \verb{bdtDt} module is created using Rcpp modules and wraps a
+  helper class \verb{bdtDt} around Boost Date_time date
+  functionality provided by the Boost class \code{boost::gregorian::date}.
 
-  The \verb{bdtDate} variable is an instance of the class created by Rcpp
-  modules. It contain just the \code{date} class from Boost Date_time; see
-  \code{print(bdtDate)} for the available methods. 
-  
   New instances can be created using either the default constructor
   (without arguments) or the constructor using year, month, date arguments.
+
+  The \verb{bdt} variable is a default instance of this \code{bdtDt}
+  reference class. It facilities accessing the member functions via
+  utility function, see for example \code{\link{getEndOfBizWeek}} or
+  \code{print(bdtDt)} for the available methods.
+  
 }
 \section{Method}{
   \describe{
-    \item{show}{\code{signature(x = "Rcpp_date")}: prints a (BDT) date class object}
-    \item{format}{\code{signature(x = "Rcpp_date")}: formats a (BDT) date class object}
+    \item{show}{\code{signature(x = "Rcpp_bdtDt")}: prints a (bdtDt) date class object}
+    \item{format}{\code{signature(x = "Rcpp_bdtDt")}: formats a (bdtDt) date class object}
   }
 }
 \details{

Modified: pkg/RcppBDT/man/bdtPt.Rd
===================================================================
--- pkg/RcppBDT/man/bdtPt.Rd	2012-09-22 17:02:33 UTC (rev 3776)
+++ pkg/RcppBDT/man/bdtPt.Rd	2012-09-22 17:10:39 UTC (rev 3777)
@@ -18,8 +18,8 @@
 }
 \section{Method}{
   \describe{
-    \item{show}{\code{signature(x = "Rcpp_bdtPt")}: prints a (BDTpt) ptime class object}
-    \item{format}{\code{signature(x = "Rcpp_bdtPt")}: formats a (BDTpt) ptime class object}
+    \item{show}{\code{signature(x = "Rcpp_bdtPt")}: prints a (bdtPt) ptime class object}
+    \item{format}{\code{signature(x = "Rcpp_bdtPt")}: formats a (bdtPt) ptime class object}
   }
 }
 \details{

Modified: pkg/RcppBDT/man/bdtTz.Rd
===================================================================
--- pkg/RcppBDT/man/bdtTz.Rd	2012-09-22 17:02:33 UTC (rev 3776)
+++ pkg/RcppBDT/man/bdtTz.Rd	2012-09-22 17:10:39 UTC (rev 3777)
@@ -22,8 +22,8 @@
 }
 \section{Method}{
   \describe{
-    \item{show}{\code{signature(x = "Rcpp_bdtTz")}: prints a (BDTtz) timezone class object}
-    \item{format}{\code{signature(x = "Rcpp_bdtTz")}: formats a (BDTtz) timezone class object}
+    \item{show}{\code{signature(x = "Rcpp_bdtTz")}: prints a (bdtTz) timezone class object}
+    \item{format}{\code{signature(x = "Rcpp_bdtTz")}: formats a (bdtTz) timezone class object}
   }
 }
 \details{