version 0.4.0

DESCRIPTION

@@ -2,29 +2,24 @@ Package: gustave
 Type: Package
 Title: A User-Oriented Statistical Toolkit for Analytical Variance
         Estimation
-Depends: R(>= 3.3.0)
-Imports: Matrix, methods, stats, MASS
-Suggests: testthat, sampling, vardpoor
-Version: 0.3.0
+Depends: R(>= 3.2.5)
+Imports: methods, utils, stats, Matrix
+Suggests: testthat, sampling, magrittr, tibble, dplyr, data.table
+Version: 0.4.0
 Authors@R: person("Martin", "Chevalier", role = c("aut", "cre", "cph"), email = "martin.chevalier@insee.fr")
 Author: Martin Chevalier [aut, cre, cph]
 Maintainer: Martin Chevalier <martin.chevalier@insee.fr>
 URL: https://github.com/martinchevalier/gustave
 BugReports: https://github.com/martinchevalier/gustave/issues
-Description: 
-  Provides a toolkit for analytical variance estimation in survey sampling. Apart from
-  the implementation of standard variance estimators, its main feature is to help the
-  sampling expert produce easy-to-use variance estimation "wrappers", where systematic
-  operations (linearization, domain estimation) are handled in a consistent and transparent
-  way for the end user.
+Description: Provides a toolkit for analytical variance estimation in survey sampling. Apart from the implementation of standard variance estimators, its main feature is to help the sampling expert produce easy-to-use variance estimation "wrappers", where systematic operations (linearization, domain estimation) are handled in a consistent and transparent way.
 License: GPL-3
 Collate: 'data.R' 'utils.R' 'define_variance_wrapper.R'
-        'variance_function.R' 'define_linearization_wrapper.R'
-        'linearization_wrapper_standard.R'
+        'variance_function.R' 'define_statistic_wrapper.R'
+        'standard_statistic_wrapper.R' 'qvar.R'
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 6.0.1
+RoxygenNote: 6.1.0
 NeedsCompilation: no
-Packaged: 2018-06-05 10:13:41 UTC; gc004y
+Packaged: 2018-08-30 14:41:40 UTC; root
 Repository: CRAN
-Date/Publication: 2018-06-06 10:57:54 UTC
+Date/Publication: 2018-08-31 08:50:03 UTC

MD5

@@ -1,31 +1,41 @@
-8f5c2260b6ccb083123baf75b8257fec *DESCRIPTION
-91880814741925e785cae8f2c41e08b2 *NAMESPACE
-51060c716262ae470bbbf42430a795fb *NEWS.md
-ebb51fb5b0e3f9b27e10eef41b7aae47 *R/data.R
-53633df58319bff6c34cd221e3950212 *R/define_linearization_wrapper.R
-102424bb8ef6c38253a3157b99e3baf6 *R/define_variance_wrapper.R
-a57e30f0051232e5bb29773062153416 *R/linearization_wrapper_standard.R
-750d4e4f6a16bb1cd3a84a432c894f8a *R/utils.R
-c96c290e003489983e7e4c02876fc183 *R/variance_function.R
-4d8d99c908b5ac4039581f7fec3d2292 *README.md
-0870fcf3d5172672081245da1c05b9c9 *data/ict_pop.RData
-8a70ef048c7396290cb84a16302e13a4 *data/ict_sample.RData
-49e1f4f2f2fdb31fa882fb621ea6bcdd *data/ict_survey.RData
-2a9261d3e2c6b9a2366d014ea8b0c09f *man/add0.Rd
-69ef4e74da05b417c7d53d9525f65287 *man/define_linearization_wrapper.Rd
-39762731288e7ddde26e2e2016837f70 *man/define_variance_wrapper.Rd
-288191ccf77d2678afdb4c8fbe22b03a *man/ict_pop.Rd
-d5ba39cc41aa667aa24a4d1f04d3c351 *man/ict_sample.Rd
-548f610bd1fc82fb9c557f709b8f5f40 *man/ict_survey.Rd
-cf1700c6e2420367d45321b063c41296 *man/linearization_wrapper_standard.Rd
-035009d9d873192075d924da70a52ac4 *man/rescal.Rd
-006505dd3d3bf9ae2e17061e62819cee *man/sumby.Rd
-74859be7486e481b83e3fa777228119c *man/varDT.Rd
-bde6a9e3b7e419a98a86f379d0fa2f90 *man/varSYG.Rd
-f5b5174836ed01a616bdcb59d427fe65 *man/var_pois.Rd
-b64a36634ff32b6814849e4d3f104669 *tests/testthat.R
-8fcc043daaecff41d7956b33733fcd28 *tests/testthat/test_data.R
-c429c11490868e5918bbc12f30020ea5 *tests/testthat/test_define_variance_wrapper.R
-96716fb61cb68d183d90356a35deda9c *tests/testthat/test_linearization_wrapper_standard.R
-5f05ba731848289a23bd61436db98acb *tests/testthat/test_utils.R
-23b39bbb1d0d25eefd76cad2c4249212 *tests/testthat/test_variance_function.R
+e50d6c394adfd82285b190ea9fb3ad6e *DESCRIPTION
+c9e9157b0cb66ec5ebc367b650c81190 *NAMESPACE
+a4ee5937ba2cf7ac65026d5c2b92acc9 *NEWS.md
+6a8f960eb5a01db80959beb76a096f38 *R/data.R
+a74e31826d5d9065b413f35b63bd1ef9 *R/define_statistic_wrapper.R
+9c4e35b8eb90377d2bc552a286791314 *R/define_variance_wrapper.R
+802e1bcb5338e937df7ad2e466bef499 *R/qvar.R
+28b80238301c28129de7783228cc8b4f *R/standard_statistic_wrapper.R
+a024fa61acef37fb9cd8f6a64b14f2f6 *R/utils.R
+b88c948cb8f803decaae2a2f105529e0 *R/variance_function.R
+5b2a5139e9376b9e23c52590e77b126e *README.md
+8c938e5f0102972669f4ef1ec452bcc5 *data/ict_pop.RData
+f40387363e8e3a4a79446ce9ec1e381f *data/ict_sample.RData
+b2ff22127820bcf56be7e808af58be8f *data/ict_survey.RData
+48b98cc892d1cdf79971ebabeb3cb931 *data/lfs_samp_area.RData
+bf1e868ad87514b21cb573a252b6a572 *data/lfs_samp_dwel.RData
+c8e1be9f23795cc864502d4b89c5436b *data/lfs_samp_ind.RData
+b0ac8fecb046a12de4139026cd1e0b16 *man/add_zero.Rd
+70cc63036acb1a298bbc70cb3c22b7f4 *man/define_statistic_wrapper.Rd
+26ab3ef96df904b6d2d449a563545734 *man/define_variance_wrapper.Rd
+cee1c4c83cf4453018d5cfcdeb636235 *man/ict_pop.Rd
+f5797bae17bfa8aa60b7581faf8fbced *man/ict_sample.Rd
+0c0fc4cbd9f5dba08c4ddc0b700d0066 *man/ict_survey.Rd
+a18753f69aeb67136ae9d96442ff1d76 *man/lfs_samp_area.Rd
+84aa8214447918f1191a9c9ad514a7b4 *man/lfs_samp_dwel.Rd
+2701efe68030805889ac08ffd36df495 *man/lfs_samp_ind.Rd
+c2dbd6245a7ad53d7a414b3849325762 *man/qvar.Rd
+847cec06c2e5ba8a06da7b3d758b622e *man/res_cal.Rd
+539e4dd6b2d06bca77d5050e7ef91550 *man/standard_statistic_wrapper.Rd
+c6a83fc3ef716a586a19dd91fa9c10d1 *man/sum_by.Rd
+0e2158131c7ef7576132363de79d5092 *man/varDT.Rd
+3a7fad3be9e01082f3f2a0cd530acc11 *man/varSYG.Rd
+77cf51f37b02b29982179544a006de94 *man/var_pois.Rd
+267fa81060b9e8ccee84f8ef2a68a150 *tests/testthat.R
+4ad05200db3f34399016f49a02659bd9 *tests/testthat/test_data.R
+c456b64214b63c07af9fb326d75b19de *tests/testthat/test_define_statistic_wrapper.R
+6b7b20cf33e4118270dc38dde0162d59 *tests/testthat/test_define_variance_wrapper.R
+c4f2c0b27affc300dac2abd048e353bd *tests/testthat/test_qvar.R
+a013785a23d1f9c8914db3d18e889f24 *tests/testthat/test_standard_statistic_wrapper.R
+9d17c33baa22945661e77a1168bc4ccb *tests/testthat/test_utils.R
+bd6e46af36af4fcffc4980a2fcd94d33 *tests/testthat/test_variance_function.R

NAMESPACE

@@ -1,12 +1,13 @@
-# Generated by roxygen2: do not edit by hand
-
-export(add0)
-export(define_linearization_wrapper)
-export(define_variance_wrapper)
-export(rescal)
-export(sumby)
-export(varDT)
-export(varSYG)
-export(var_pois)
-export(var_srs)
-import(Matrix)
+# Generated by roxygen2: do not edit by hand
+
+export(add_zero)
+export(define_statistic_wrapper)
+export(define_variance_wrapper)
+export(qvar)
+export(res_cal)
+export(sum_by)
+export(varDT)
+export(varSYG)
+export(var_pois)
+export(var_srs)
+import(Matrix)

NEWS.md

@@ -1,42 +1,68 @@
-
-# 0.3.0
-
-- Simulated data added
-- Significant increase of unit tests
-- Documentation completed
-- Simplification of the structure of the main object processed by the variance wrapper
-- Removal of unnecessary arguments in linearization wrappers
-- Removal of the linerization wrappers for the Laeken indicators based on the vardpoor package (better integration in a future release)
-- Preparation for a first CRAN release
-
-# 0.2.7
-
-- Now linearization with all data parameters set to NULL are discarded from the estimation.
-
-# 0.2.6 
-
-- Bug fix: evaluation of variables can occur either in the data argument or in the evaluation environment (envir argument)
-
-# 0.2.3-0.2.5
-
-- Several attempts to output more metadata from linearization functions. 
-- At the end : ratio() gains two metadata slots, est_num and est_denom
-
-# 0.2.2
-
-- Minor bug fixes
-
-# 0.2.1
-
-- Beginning of the documentation
-- Renaming of numerous functions and arguments
-- Change the precalc structure in varDT
-- Normalize the treatment of weights
-- New linearization wrappers: gini() and arpr()
-
-# 0.1.3-0.1.7
-
-- No more dependency to package pryr
-- Add the generalized inverse in `varDT`
-- Other bug fixes
-
+# 0.4.0
+
+- Breaking: Heavy remanufacturing of `define_variance_wrapper`
+
+    * New: `technical_data` argument offers a more consistent way to include technical data within the enclosing environment of the wrapper. `objects_to_include` is kept for non-data objects (such as additional statistic wrappers) or advanced customization.
+    * New: `technical_param` argument offers a more convenient way to specify default values for parameters used by the variance function.
+    * New: `reference_weight` replaces `default$weight`. This means that the reference weight used for point estimation and linearization is set while defining the variance wrapper and not at run-time.
+    * Deprecated: `stat`, which was a remain of an early implementation of linearization functions, is not a parameter of the variance wrappers anymore. Its purpose (to apply a given variance wrapper to several variables without having to type the name of the linearization wrapper) is now covered by the standard evaluation capabilities of statistic wrappers (see below).
+    * Deprecated: `default` is replaced by `default_id`, as `default$weight` and `default$stat` are no longer needed. As for `default$alpha`, its value is set to 0.05 and cannot be changed anymore while defining the variance wrapper (as this can easily be done afterwards using `formals<-`).
+    * Deprecated: `objects_to_include_from`
+
+- Breaking: Rebranding and heavy remanufacturing of `define_statistic_wrapper` (previously known as `define_linearization_wrapper`), added support for standard evaluation (see `define_variance_wrapper` examples).
+
+- New: the `qvar` function allows for a straigthforward variance estimation in common cases (stratified simple random sampling with non-response through reweighting and calibration) and performs both technical and methodological checks.
+
+- Some normalization in function names: `add0` becomes `add_zero`, `sumby` becomes `sum_by`, `rescal` becomes `res_cal`
+
+- Example data: calibration variables in ict_sample instead of ict_survey, new LFS example data
+
+- Significant increase of unit tests
+
+
+
+# 0.3.1
+
+- Hotfix: Add calibrated weights to `define_variance_wrapper` example.
+
+# 0.3.0
+
+- Simulated data added
+- Significant increase of unit tests
+- Documentation completed
+- Simplification of the structure of the main object processed by the variance wrapper
+- Removal of unnecessary arguments in linearization wrappers
+- Removal of the linerization wrappers for the Laeken indicators based on the vardpoor package (better integration in a future release)
+- Preparation for a first CRAN release
+
+# 0.2.7
+
+- Now linearization with all data parameters set to NULL are discarded from the estimation.
+
+# 0.2.6 
+
+- Bug fix: evaluation of variables can occur either in the data argument or in the evaluation environment (envir argument)
+
+# 0.2.3-0.2.5
+
+- Several attempts to output more metadata from linearization functions. 
+- At the end : ratio() gains two metadata slots, est_num and est_denom
+
+# 0.2.2
+
+- Minor bug fixes
+
+# 0.2.1
+
+- Beginning of the documentation
+- Renaming of numerous functions and arguments
+- Change the precalc structure in varDT
+- Normalize the treatment of weights
+- New linearization wrappers: gini() and arpr()
+
+# 0.1.3-0.1.7
+
+- No more dependency to package pryr
+- Add the generalized inverse in `varDT`
+- Other bug fixes
+