version 0.1-3

DESCRIPTION

@@ -1,24 +1,24 @@
 Package: maSAE
 Type: Package
-Title: Mandallaz' model-assisted small area estimators
-Version: 0.1-2
-Date: 2014-04-27
+Title: Mandallaz' Model-Assisted Small Area Estimators
+Version: 0.1-3
+Date: 2015-07-02
 Authors@R: c(person(given = c("Andreas", "Dominik"), family = "Cullmann",
     email = "r-package_masae@arcor.de", role = c("aut","cre"), comment = NULL,
     first = NULL, last = NULL)
     , person(given = c("Daniel"), family=c("Mandallaz"), role = c("ctb"))
     , person(given = c("Alexander", "Francis"), family=c("Massey"), role = c("ctb"))
     )
-Description: an S4 implementation of the unbiased extension of the model-assisted synthetic-regression estimator proposed by Mandallaz (2013), Mandallaz et al. (2013) and Mandallaz (2014).
+Description: An S4 implementation of the unbiased extension of the model-assisted synthetic-regression estimator proposed by Mandallaz (2013), Mandallaz et al. (2013) and Mandallaz (2014).
     It yields smaller variances than the standard bias correction, the generalised regression estimator.
 License: GPL (>= 2)
 Depends: methods
 Suggests: nlme
-Packaged: 2014-04-27 19:21:14 UTC; qwer
+NeedsCompilation: no
+Packaged: 2015-07-02 21:10:09 UTC; qwer
 Author: Andreas Dominik Cullmann [aut, cre],
   Daniel Mandallaz [ctb],
   Alexander Francis Massey [ctb]
 Maintainer: Andreas Dominik Cullmann <r-package_masae@arcor.de>
-NeedsCompilation: no
 Repository: CRAN
-Date/Publication: 2014-04-28 07:10:28
+Date/Publication: 2015-07-03 01:26:13

MD5

@@ -1,13 +1,13 @@
 c89f9b7aa0a2dde9f298d0c612ac7af8 *ChangeLog
-d49c38c3fd99effa9b7dcaf197284fa9 *DESCRIPTION
+c4f31544385a83286fba87edc5ff591f *DESCRIPTION
 e6e3cd204e77215b98be08208bcd8641 *NAMESPACE
 74083c0bcaf5c9d9783e7d4ae045f497 *R/allClasses.R
 ab1deee3e6f6d4924233e7d2c6080905 *R/allConstructors.R
 aea5ca34a74f675d93b7df366bc8af04 *R/allGenerics.R
 c60f23729fb15696b32771bff569c514 *R/data.R
 de2485eea3c67b52b07b368b3ed054d3 *R/maSAE-package.R
 b59aed599ca03ba82c48bfc05ac91f5b *R/predict-methods.R
-7e59a93d923f9e9fdbbbb5e87056d9ab *build/vignette.rds
+51e2577ffd35489492566fbc310922e1 *build/vignette.rds
 9c17fa58275c16b730237c71f5328da5 *data/s0.txt.gz
 efb9cb242e576654acca5fd9d2b95b53 *data/s1.txt.gz
 8724a49c77d293ddd698324e123e04bf *data/s2.txt.gz
@@ -17,17 +17,17 @@ a116e4b64d094b56f46825bda17c39de *demo/design.R
 55c0367840d32a2c0b29c6720a8bbde1 *inst/doc/Rao.R
 e2833088cd33bf6ae8973238a6c99827 *inst/doc/maSAE.R
 b2b764b909030581313e13d3bb1989fb *inst/doc/maSAE.Rnw
-9cc98844809592603098610e5b83f846 *inst/doc/maSAE.pdf
-af9ec310000339f14a7cd763b12866f4 *man/maSAE-internal.Rd
-3f9f7d647e36c732be4478bbf5ffb4dd *man/maSAE-package.Rd
-7726496ecfbef6cce8711163dde3a5c5 *man/predict-methods.Rd
-06dceb749d2fdcc356ec50ed28c4401a *man/s0.Rd
-f27a54d241352545592a4b5c4a9e6679 *man/s1.Rd
-71e39a9dc12239ab910c9e9bcd258089 *man/s2.Rd
-56f927bf67871745d667fd8c4bec460b *man/saObj.Rd
-51661a31fc81f4733bf1e785f1d7d08e *man/sadObj-class.Rd
-41caa12043fc64a174054c7f1d597121 *man/saeObj-class.Rd
-59d95699c82babf4809ee131e74b752a *man/savObj-class.Rd
+7a89bad875793d892d015afba2a424c2 *inst/doc/maSAE.pdf
+8454d6e332c4294b34c7024c93e6943a *man/maSAE-internal.Rd
+701276e4c96608dedbc243507717d5ef *man/maSAE-package.Rd
+dbd5dc3813beb5d17ed6ccfe1080bc18 *man/predict-methods.Rd
+0142937a834ad6fae68de5e13f72ac3f *man/s0.Rd
+bbecd3250325829e261f6939b4055e3f *man/s1.Rd
+176e8da93b9c79543b4b5c75a784565b *man/s2.Rd
+32a5c8c0f2000669829b025bfc3d8339 *man/saObj.Rd
+d3f94c92c922c44997a5720cd515cffb *man/sadObj-class.Rd
+cdf5b51376b20c2b06e73aae80f925a9 *man/saeObj-class.Rd
+8728db2cd6f6a614af6a6a84cf064748 *man/savObj-class.Rd
 a116e4b64d094b56f46825bda17c39de *tests/design.R
 f6a256daadbae5aa916df9eda6c367eb *tests/dontrun.R
 38407a52b0514ad5879f27c260be808a *tests/inputs.R

man/maSAE-internal.Rd

@@ -1,3 +1,5 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/allClasses.R, R/predict-methods.R
 \docType{class}
 \name{characterOrNULL-class}
 \alias{characterOrNULL-class}
@@ -6,21 +8,22 @@
 \title{Class \code{"characterOrNULL"}}
 \format{chr}
 \description{
-the _union_ of classes \code{character} and \code{NULL}
+the  _union_ of classes \code{character} and  \code{NULL}
 
-the _union_ of classes \code{data.frame} and \code{NULL}
+the  _union_ of classes \code{data.frame} and  \code{NULL}
 
-internal character object to store information about the
-literature used in the reference-attribute of the objects
-returned by \code{\link[=predict]{?maSAE::predict}}.
+internal character object to store information about the literature used
+in the reference-attribute of the objects returned by
+\code{\link[=predict]{?maSAE::predict}}.
 }
 \details{
 used by \linkS4class{savObj}, \linkS4class{saeObj}
 
 used by \linkS4class{saeObj}
 }
 \section{Objects from the Class}{
-  A virtual Class: No objects may be created from it.
+ A virtual Class: No objects may be created
+from it.
 }
 \examples{
 showClass("characterOrNULL")

man/maSAE-package.Rd

@@ -1,3 +1,5 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/maSAE-package.R
 \docType{package}
 \name{maSAE-package}
 \alias{maSAE-package}
@@ -6,59 +8,57 @@
 \description{
 an S4 implementation of the unbiased extension of the
 model-assisted' synthetic-regression estimator proposed by
-Mandallaz (2013), Mandallaz et al. (2013) and Mandallaz
-(2014).\cr It yields smaller variances than the standard
-bias correction, the generalised regression estimator.
+Mandallaz (2013), Mandallaz et al. (2013) and Mandallaz (2014).\cr
+It yields smaller variances than the standard bias correction,
+the generalised regression estimator.
 }
 \details{
-This package provides Mandallaz' extended
-synthetic-regression estimator for two- and three-phase
-sampling designs with or without clustering.\cr See
-vignette('maSAE', package = 'maSAE') and demo('maSAE',
-package = 'maSAE') for introductions,
-\code{"\link[=saeObj-class]{class?maSAE::saeObj}"} and
-\code{"\link[=predict]{?maSAE::predict}"} for help on the
-main feature.
+This package provides Mandallaz' extended synthetic-regression estimator for two- and
+three-phase sampling designs with or without clustering.\cr
+See vignette('maSAE', package = 'maSAE') and demo('maSAE', package = 'maSAE') for
+introductions, \code{"\link[=saeObj-class]{class?maSAE::saeObj}"} and
+\code{"\link[=predict]{?maSAE::predict}"} for help on the main feature.
 }
 \note{
-Model-assisted estimators use models to improve the
-efficiency (i.e. reduce prediction error compared to
-design-based estimators) but need not assume them to be
-correct as in the model-based approach, which is
-advantageous in official statistics.
+Model-assisted estimators use models to improve the efficiency (i.e. reduce
+prediction error compared to design-based estimators) but need not assume them to be
+correct as in the model-based approach, which is advantageous in official
+statistics.
 }
 \examples{
 \dontrun{vignette('maSAE', package = 'maSAE')}
 \dontrun{demo('design', package = 'maSAE')}
 \dontrun{demo('maSAE', package = 'maSAE')}
 }
 \references{
-\cite{ Mandallaz, D. 2013 Design-based properties of some
-small-area estimators in forest inventory with two-phase
-sampling. Canadian Journal of Forest Research \bold{43}(5),
-pp. 441--449. doi:
-\href{http://dx.doi.org/10.1139/cjfr-2012-0381}{10.1139/cjfr-2012-0381}.
+\cite{
+Mandallaz, D. 2013
+Design-based properties of some small-area estimators in forest
+inventory with two-phase sampling.
+Canadian Journal of Forest Research \bold{43}(5), pp. 441--449.
+doi: \href{http://dx.doi.org/10.1139/cjfr-2012-0381}{10.1139/cjfr-2012-0381}.
 }
 
-\cite{ Mandallaz, and Breschan, J.  and Hill, A. 2013 New
-regression estimators in forest inventories with two-phase
-sampling and partially exhaustive information: a
-design-based Monte Carlo approach with applications to
-small-area estimation. Canadian Journal of Forest Research
-\bold{43}(11), pp. 1023--1031. doi:
-\href{http://dx.doi.org/10.1139/cjfr-2013-0181}{10.1139/cjfr-2013-0181}.
+\cite{
+Mandallaz, and Breschan, J.  and  Hill, A. 2013
+New regression estimators in forest inventories with two-phase sampling and partially
+exhaustive information: a design-based Monte Carlo approach with applications to
+small-area estimation.
+Canadian Journal of Forest Research \bold{43}(11), pp. 1023--1031.
+doi: \href{http://dx.doi.org/10.1139/cjfr-2013-0181}{10.1139/cjfr-2013-0181}.
 }
 
-\cite{ Mandallaz, D. 2014 A three-phase sampling extension
-of the generalized regression estimator with partially
-exhaustive information. Canadian Journal of Forest Research
-\bold{44}(4), pp. 383--388. doi:
-\href{http://dx.doi.org/10.1139/cjfr-2013-0449}{10.1139/cjfr-2013-0449}.
+\cite{
+Mandallaz, D. 2014
+A three-phase sampling extension of the generalized regression
+estimator with partially exhaustive information.
+Canadian Journal of Forest Research \bold{44}(4), pp. 383--388.
+doi: \href{http://dx.doi.org/10.1139/cjfr-2013-0449}{10.1139/cjfr-2013-0449}.
 }
 }
 \seealso{
-There are a couple packages for model-\strong{based} small
-area estimation, see \code{\link[sae:sae-package]{sae}},
+There are a couple packages for model-\strong{based} small area estimation, see
+\code{\link[sae:sae-package]{sae}},
 \code{\link[rsae:rsae-package]{rsae}},
 \code{\link[hbsae:hbsae-package]{hbsae}} and
 \code{\link[JoSAE:JoSAE-package]{JoSAE}}.

man/predict-methods.Rd

@@ -1,3 +1,5 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/allGenerics.R, R/predict-methods.R
 \docType{methods}
 \name{predict}
 \alias{predict}
@@ -13,45 +15,42 @@ predict(object, ...)
 \S4method{predict}{saeObj}(object)
 }
 \arguments{
-  \item{object}{a model object for which prediction is
-  desired.}
+\item{object}{a model object for which prediction is desired.}
 
-  \item{...}{Arguments to be passed to methods.}
+\item{...}{Arguments to be passed to methods.}
 }
 \value{
-a data frame containing predictions and variances for each
-small area, attr(\dots, 'references') gives information on
-the literature used, attr(\dots$prediction, 'reference')
-and attr(\dots$variance, 'reference') specify these.
+a data frame containing predictions and variances for each small area,
+attr(\dots, 'references') gives information on the literature used,
+attr(\dots$prediction, 'reference') and  attr(\dots$variance, 'reference') specify these.
 }
 \description{
 Calculate small area predictions and their variances
 }
 \details{
-Based on the structure of the \code{saeObj} given,
-\code{predict} decides, which predictor to use:\cr If a
-smallAreaMeans-data.frame covering all fixed effects is
-given, the exhaustive estimator \eqn{\hat{\tilde{Y}}_{G,
-synth}} is calculated.  \cr If a smallAreaMeans-data.frame
-not covering all fixed effects is given, the partially
-exhaustive estimator \eqn{\hat{\tilde{Y}}_{G, greg}} is
-calculated.  \cr If no smallAreaMeans-data.frame but s1 is
-given, the three-phase estimator \eqn{\hat{\tilde{Y}}_{G,
-g3reg}} is calculated.  \cr If neither smallAreaMeans nor
-s1 are given, the non-exhaustive estimator
-\eqn{\hat{\tilde{Y}}_{G, psynth}} is calculated.  \cr If a
-clustering variable is given, the cluster sampling design
-equivalents of the above estimators are used.
+Based on the structure of the \code{saeObj} given, \code{predict} decides, which
+predictor to use:\cr
+If a smallAreaMeans-data.frame covering all fixed effects is given, the exhaustive
+estimator \eqn{\hat{\tilde{Y}}_{G, synth}} is calculated.  \cr
+If a smallAreaMeans-data.frame not covering all fixed effects is given, the partially
+exhaustive
+estimator \eqn{\hat{\tilde{Y}}_{G, greg}} is calculated.  \cr
+If no smallAreaMeans-data.frame but s1 is given, the three-phase
+estimator \eqn{\hat{\tilde{Y}}_{G, g3reg}} is calculated.  \cr
+If neither smallAreaMeans nor s1 are given, the non-exhaustive
+estimator \eqn{\hat{\tilde{Y}}_{G, psynth}} is calculated.  \cr
+If a clustering variable is given, the cluster sampling design equivalents of the
+above estimators are used.
 }
 \section{Methods}{
-  \describe{
+ \describe{
 
-  \item{\code{signature(object = saeObj)}}{Calculate
-  predictions and variances according to the auxilliary
-  information given, see Details above.}
+\item{\code{signature(object = saeObj)}}{Calculate predictions and variances
+according to the auxilliary information given, see Details above.}
 
-  \item{\code{signature(object = sadObj)}}{Calculate
-  design-based predictions and variances.} }
+\item{\code{signature(object = sadObj)}}{Calculate design-based predictions and
+variances.}
+}
 }
 \examples{
 library('maSAE')

man/s0.Rd

@@ -1,3 +1,5 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/data.R
 \docType{data}
 \name{s0}
 \alias{s0}
@@ -7,18 +9,17 @@
 data(s0)
 }
 \description{
-Artifical null phase sampling data used for examples in the
-maSAE package.
+Artifical null phase sampling data used for examples in the maSAE package.
 }
 \details{
-\describe{ \item{\code{clustid}}{See
-\code{"\link[=s2]{?maSAE::s2}"}} \item{\code{x1}}{See
-\code{"\link[=s2]{?maSAE::s2}"}} \item{\code{x2}}{See
-\code{"\link[=s2]{?maSAE::s2}"}} \item{\code{x3}}{See
-\code{"\link[=s2]{?maSAE::s2}"}}
-\item{\code{inclusion}}{See
-\code{"\link[=s2]{?maSAE::s2}"}} \item{\code{g}}{See
-\code{"\link[=s2]{?maSAE::s2}"}} }
+\describe{
+   \item{\code{clustid}}{See \code{"\link[=s2]{?maSAE::s2}"}}
+   \item{\code{x1}}{See \code{"\link[=s2]{?maSAE::s2}"}}
+   \item{\code{x2}}{See \code{"\link[=s2]{?maSAE::s2}"}}
+   \item{\code{x3}}{See \code{"\link[=s2]{?maSAE::s2}"}}
+   \item{\code{inclusion}}{See \code{"\link[=s2]{?maSAE::s2}"}}
+   \item{\code{g}}{See \code{"\link[=s2]{?maSAE::s2}"}}
+ }
 }
 \keyword{datasets}
 

man/s1.Rd

@@ -1,3 +1,5 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/data.R
 \docType{data}
 \name{s1}
 \alias{s1}
@@ -7,18 +9,17 @@
 data(s1)
 }
 \description{
-Artifical first phase sampling data used for examples in
-the maSAE package.
+Artifical first phase sampling data  used for examples in the maSAE package.
 }
 \details{
-\describe{ \item{\code{clustid}}{See
-\code{"\link[=s2]{?maSAE::s2}"}} \item{\code{x1}}{See
-\code{"\link[=s2]{?maSAE::s2}"}} \item{\code{x2}}{See
-\code{"\link[=s2]{?maSAE::s2}"}} \item{\code{x3}}{See
-\code{"\link[=s2]{?maSAE::s2}"}}
-\item{\code{inclusion}}{See
-\code{"\link[=s2]{?maSAE::s2}"}} \item{\code{g}}{See
-\code{"\link[=s2]{?maSAE::s2}"}} }
+\describe{
+   \item{\code{clustid}}{See \code{"\link[=s2]{?maSAE::s2}"}}
+   \item{\code{x1}}{See \code{"\link[=s2]{?maSAE::s2}"}}
+   \item{\code{x2}}{See \code{"\link[=s2]{?maSAE::s2}"}}
+   \item{\code{x3}}{See \code{"\link[=s2]{?maSAE::s2}"}}
+   \item{\code{inclusion}}{See \code{"\link[=s2]{?maSAE::s2}"}}
+   \item{\code{g}}{See \code{"\link[=s2]{?maSAE::s2}"}}
+ }
 }
 \keyword{datasets}
 

man/s2.Rd

@@ -1,3 +1,5 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/data.R
 \docType{data}
 \name{s2}
 \alias{s2}
@@ -7,17 +9,18 @@
 data(s2)
 }
 \description{
-Artifical second phase sampling data used for examples in
-the maSAE package.
+Artifical second phase sampling data  used for examples in the maSAE package.
 }
 \details{
-\describe{ \item{\code{clustid}}{index giving the
-clusters}.  \item{\code{x1}}{a potential fixed effect.}
-\item{\code{x2}}{another potential fixed effect.}
-\item{\code{x3}}{yet another potential fixed effect.}
-\item{\code{inclusion}}{a logical vector indicating whether
-or not to include the current observation. All TRUE.}
-\item{\code{y}}{the predictand} }
+\describe{
+   \item{\code{clustid}}{index giving the clusters}.
+   \item{\code{x1}}{a potential fixed effect.}
+   \item{\code{x2}}{another potential fixed effect.}
+   \item{\code{x3}}{yet another potential fixed effect.}
+   \item{\code{inclusion}}{a logical vector indicating whether or not to include the
+   current observation. All TRUE.}
+   \item{\code{y}}{the predictand}
+ }
 }
 \keyword{datasets}