From 1f540bf89e708c90f9a82761fbac4c2629ccbd77 Mon Sep 17 00:00:00 2001 From: Greg Freedman Ellis Date: Wed, 5 Oct 2022 16:16:16 -0500 Subject: [PATCH] pkgdown --- docs/404.html | 2 +- docs/CODE_OF_CONDUCT.html | 31 ++- docs/articles/extending-srvyr.html | 100 +++++++-- docs/articles/index.html | 2 +- docs/articles/srvyr-database.html | 119 ++++++++--- docs/articles/srvyr-vs-survey.html | 260 +++++++++++++++++++----- docs/authors.html | 2 +- docs/index.html | 157 ++++++++++---- docs/news/index.html | 191 ++++++++++++----- docs/pkgdown.yml | 4 +- docs/reference/as_srvyr_result_df.html | 2 +- docs/reference/as_survey.html | 2 +- docs/reference/as_survey_design.html | 2 +- docs/reference/as_survey_rep.html | 2 +- docs/reference/as_survey_twophase.html | 2 +- docs/reference/as_tibble.html | 2 +- docs/reference/cascade.html | 2 +- docs/reference/collect.html | 2 +- docs/reference/cur_svy.html | 2 +- docs/reference/cur_svy_wts.html | 2 +- docs/reference/current_svy.html | 1 + docs/reference/dplyr_filter_joins.html | 2 +- docs/reference/dplyr_single.html | 2 +- docs/reference/get_var_est.html | 2 +- docs/reference/group_by.html | 2 +- docs/reference/group_map_dfr.html | 2 +- docs/reference/groups.html | 2 +- docs/reference/index.html | 5 +- docs/reference/interact.html | 2 +- docs/reference/pipe.html | 2 +- docs/reference/reexports.html | 2 +- docs/reference/rlang-tidyeval.html | 2 +- docs/reference/set_survey_vars.html | 2 +- docs/reference/srvyr-se-deprecated.html | 2 +- docs/reference/srvyr.html | 2 +- docs/reference/srvyr_interaction.html | 2 +- docs/reference/summarise.html | 2 +- docs/reference/summarise_all.html | 2 +- docs/reference/survey_mean.html | 11 +- docs/reference/survey_old_quantile.html | 11 +- docs/reference/survey_quantile.html | 11 +- docs/reference/survey_ratio.html | 11 +- docs/reference/survey_tally.html | 2 +- docs/reference/survey_total.html | 11 +- docs/reference/survey_var.html | 2 +- docs/reference/svychisq.html | 2 +- docs/reference/tbl_svy.html | 2 +- docs/reference/tbl_vars.html | 2 +- docs/reference/uninteract.html | 2 +- docs/reference/unweighted.html | 2 +- 50 files changed, 730 insertions(+), 265 deletions(-) diff --git a/docs/404.html b/docs/404.html index d64b2bf..de719b2 100644 --- a/docs/404.html +++ b/docs/404.html @@ -72,7 +72,7 @@ srvyr - 1.1.1 + 1.1.2 diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html index 0a01385..df82af3 100644 --- a/docs/CODE_OF_CONDUCT.html +++ b/docs/CODE_OF_CONDUCT.html @@ -72,7 +72,7 @@ srvyr - 1.1.1 + 1.1.2 @@ -137,12 +137,29 @@

Contributor Code of Conduct

-

As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

-

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

-

Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

-

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.

-

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

-

This Code of Conduct is adapted from the Contributor Covenant (http://contributor-covenant.org), version 1.0.0, available at http://contributor-covenant.org/version/1/0/0/

+

As contributors and maintainers of this project, we pledge to respect +all people who contribute through reporting issues, posting feature +requests, updating documentation, submitting pull requests or patches, +and other activities.

+

We are committed to making participation in this project a +harassment-free experience for everyone, regardless of level of +experience, gender, gender identity and expression, sexual orientation, +disability, personal appearance, body size, race, ethnicity, age, or +religion.

+

Examples of unacceptable behavior by participants include the use of +sexual language or imagery, derogatory comments or personal attacks, +trolling, public or private harassment, insults, or other unprofessional +conduct.

+

Project maintainers have the right and responsibility to remove, +edit, or reject comments, commits, code, wiki edits, issues, and other +contributions that are not aligned to this Code of Conduct. Project +maintainers who do not follow the Code of Conduct may be removed from +the project team.

+

Instances of abusive, harassing, or otherwise unacceptable behavior +may be reported by opening an issue or contacting one or more of the +project maintainers.

+

This Code of Conduct is adapted from the Contributor Covenant (http://contributor-covenant.org), version 1.0.0, +available at http://contributor-covenant.org/version/1/0/0/

diff --git a/docs/articles/extending-srvyr.html b/docs/articles/extending-srvyr.html index 47d2695..9ff57c1 100644 --- a/docs/articles/extending-srvyr.html +++ b/docs/articles/extending-srvyr.html @@ -32,7 +32,7 @@ srvyr - 1.1.1 + 1.1.2 @@ -95,7 +95,7 @@

Extending srvyr

Greg Freedman Ellis

-

2022-02-20

+

2022-10-05

Source: vignettes/extending-srvyr.Rmd @@ -106,44 +106,98 @@

2022-02-20

## Loading required package: convey
## Loading required package: laeken
-

I don’t expect this vignette to be help for most srvyr users, it is instead intended for other package developers. An exciting new feature that is easier now that I have reworked srvyr’s non-standard evaluation to match dplyr 0.7+ is that it is now possible for non-srvyr functions to be called from within summarize. This vignette describes some of the inner-workings of summarize so that others can extend srvyr. This is kind of a fiddly part of srvyr, and I don’t expect that many people will want or need to understand it, so this guide is mostly aimed at package authors who already have an understanding of how survey objects work. If you’d like more explanation, please let me know on github!

-

This guide has also been rewritten for srvyr 1.0, as I had to rework summarize and was unable to maintain backwards compatibility.

+

I don’t expect this vignette to be help for most srvyr users, it is +instead intended for other package developers. An exciting new feature +that is easier now that I have reworked srvyr’s non-standard evaluation +to match dplyr 0.7+ is that it is now possible for non-srvyr functions +to be called from within summarize. This vignette describes +some of the inner-workings of summarize so that others can extend srvyr. +This is kind of a fiddly part of srvyr, and I don’t expect that many +people will want or need to understand it, so this guide is mostly aimed +at package authors who already have an understanding of how survey +objects work. If you’d like more explanation, please let me know on github!

+

This guide has also been rewritten for srvyr 1.0, as I had to rework +summarize and was unable to maintain backwards compatibility.

Translating from survey to srvyr

-

srvyr implements the “survey statistics” functions from the survey package. Some examples are the svymean, svytotal, svyciprop, svyquantile and svyratio all return a svystat object which usually prints out the estimate and its standard error and other estimates of the variance can be calculated from it. In srvyr, these estimates are created inside of a summarize call and the variance estimates are specified at the same time.

-

The combination of srvyr’s group_by and summarize is analogous to the svyby function that performs one of the survey statistic function and performs it on multiple groups. However, as of srvyr 1.0, srvyr no longer uses svyby, instead the survey object is split into each group’s

+

srvyr implements the “survey statistics” functions from the survey +package. Some examples are the svymean, svytotal, svyciprop, svyquantile +and svyratio all return a svystat object which usually +prints out the estimate and its standard error and other estimates of +the variance can be calculated from it. In srvyr, these estimates are +created inside of a summarize call and the variance estimates are +specified at the same time.

+

The combination of srvyr’s group_by and summarize is analogous to the +svyby function that performs one of the survey statistic +function and performs it on multiple groups. However, as of srvyr 1.0, +srvyr no longer uses svyby, instead the survey object is +split into each group’s

What summarize expects

-

srvyr’s summarize expects that the survey statistics functions will return objects that are formatted in a particular way. Below, I’ll explain some of the functions that will help create these objects for you in most cases, but the return should be:

+

srvyr’s summarize expects that the survey statistics functions will +return objects that are formatted in a particular way. Below, I’ll +explain some of the functions that will help create these objects for +you in most cases, but the return should be:

Helper functions exported by srvyr

-

srvyr now exports several functions that can help convert functions designed for the survey package to this format.

+

srvyr now exports several functions that can help convert functions +designed for the survey package to this format.

-

Note that these functions may not work in all cases. In srvyr, I’ve actually had to write multiple versions of get_var_est() because of minor differences in the way survey objects are returned. Hopefully they will help in most situations, or at least give you a good place to start.

+

Note that these functions may not work in all cases. In srvyr, I’ve +actually had to write multiple versions of get_var_est() +because of minor differences in the way survey objects are returned. +Hopefully they will help in most situations, or at least give you a good +place to start.

@@ -151,13 +205,19 @@

Two less important conventions that srvyr functions follow are:

  1. snake_case function names (to better match the tidyverse)
  2. -
  3. Multiple choice arguments that default to the first (so for var_type, if no parameters are specified, use only “se” not all of them).
  4. +
  5. Multiple choice arguments that default to the first (so for +var_type, if no parameters are specified, use only “se” not all of +them).

Example: convey::svygini -> survey_gini

-

That was just a lot of text, but I think it’s probably easiest just to provide an example. The convey package provides several methods for analysis of inequality using survey data. The svygini function calculates the gini coefficient. Here, we’ll write functions that make a srvyr version survey_gini.

+

That was just a lot of text, but I think it’s probably easiest just +to provide an example. The convey package provides several methods for +analysis of inequality using survey data. The svygini function +calculates the gini coefficient. Here, we’ll write functions that make a +srvyr version survey_gini.

 # S3 generic function
 survey_gini <- function(
diff --git a/docs/articles/index.html b/docs/articles/index.html
index 132e6ca..33aa362 100644
--- a/docs/articles/index.html
+++ b/docs/articles/index.html
@@ -72,7 +72,7 @@
       
 
         srvyr
-        1.1.1
+        1.1.2
       
     
diff --git a/docs/articles/srvyr-database.html b/docs/articles/srvyr-database.html index b2e5a27..cfc81ca 100644 --- a/docs/articles/srvyr-database.html +++ b/docs/articles/srvyr-database.html @@ -32,7 +32,7 @@ srvyr - 1.1.1 + 1.1.2
@@ -95,7 +95,7 @@

Databases in srvyr

Greg Freedman Ellis

-

2022-02-20

+

2022-10-05

Source: vignettes/srvyr-database.Rmd @@ -105,19 +105,41 @@

2022-02-20

## Loading required package: RSQLite
-

Srvyr 0.3 has a completely rewritten database backend. Using databases that are already stored dplyr’s tbl_lazy objects is now just as easy as working with data stored in regular R data.frames as you don’t need to have a unique identifier. Additionally, it now works more similarly to the survey package’s database code and so shouldn’t be any slower.

-

During development, I have tested using SQLite (and the now defunct MonetDBLite) databases, but in theory other database backends should work as well.

-

This vignette shows the basics of how to use srvyr with databases. It is based on analysis from the wonderful resource asdfree ( website and github ). Many thanks to ajdamico and collaborators. Specifically, I have adapted code from American Community Survey - 2011 single year analysis and the associated data preparation scripts.

+

Srvyr 0.3 has a completely rewritten database backend. Using +databases that are already stored dplyr’s tbl_lazy objects +is now just as easy as working with data stored in regular R data.frames +as you don’t need to have a unique identifier. Additionally, it now +works more similarly to the survey package’s database code and so +shouldn’t be any slower.

+

During development, I have tested using SQLite (and the now defunct +MonetDBLite) databases, but in theory other database backends should +work as well.

+

This vignette shows the basics of how to use srvyr with databases. It +is based on analysis from the wonderful resource asdfree ( website and github ). Many thanks to +ajdamico and collaborators. +Specifically, I have adapted code from American +Community Survey - 2011 single year analysis and the associated data +preparation scripts.

Database Setup

-

In order to focus on srvyr and databases, we start with a prepared dataset. The full code is available on Github, and the high level description of what it does is:

+

In order to focus on srvyr and databases, we start with a prepared +dataset. The full code is available on +Github, and the high level description of what it does is:

    -
  • Download data from acs website (currently only Alaska and Hawaii to save time, though it would be easy to adapt to download to all 50 states and Puerto Rico).

  • -
  • Merges the household and person datasets so that we can look at the variables related to each person including those at the household level

  • -
  • Selects only a few variables that will be used in this analysis to save space, but again it could easily be adapted to keep all of the variables.

  • +
  • Download data from acs website (currently only Alaska and Hawaii +to save time, though it would be easy to adapt to download to all 50 +states and Puerto Rico).

  • +
  • Merges the household and person datasets so that we can look at +the variables related to each person including those at the household +level

  • +
  • Selects only a few variables that will be used in this analysis +to save space, but again it could easily be adapted to keep all of the +variables.

-

For more information on the specifics of the American Community Survey, see the asdfree site. Now, our code loads this prepared dataset, initiates a SQLite database, and puts the data into the dataset.

+

For more information on the specifics of the American Community +Survey, see the asdfree site. Now, our code loads this prepared dataset, +initiates a SQLite database, and puts the data into the dataset.

 suppressMessages({
   library(survey)
@@ -139,7 +161,12 @@ 

# Or, if the data was already stored in the database, you could do this # acs_m_data <- tbl(db, sql("SELECT * FROM acs_m"))

-

Now that we have the data in the database, we can interact with the database directly using sql commands, or we can use dplyr’s functionality to treat it mostly the same as a local data.frame. However, the data is not stored in memory, so we could work with much larger datasets (though in this case, the data is too small for this to be a problem).

+

Now that we have the data in the database, we can interact with the +database directly using sql commands, or we can use dplyr’s +functionality to treat it mostly the same as a local +data.frame. However, the data is not stored in memory, so +we could work with much larger datasets (though in this case, the data +is too small for this to be a problem).

 # Same results
 acs_m %>% 
@@ -154,10 +181,10 @@ 

acs_m_db %>% group_by(sex) %>% summarize(hicov = mean(hicov))

-
## Warning: Missing values are always removed in SQL.
-## Use `mean(x, na.rm = TRUE)` to silence this warning
-## This warning is displayed only once per session.
-
## # Source:   lazy query [?? x 2]
+
## Warning: Missing values are always removed in SQL aggregation functions.
+## Use `na.rm = TRUE` to silence this warning
+## This warning is displayed once every 8 hours.
+
## # Source:   SQL [2 x 2]
 ## # Database: sqlite 3.37.0 [:memory:]
 ##     sex hicov
 ##   <int> <dbl>
@@ -169,8 +196,13 @@ 

## 7777312 bytes
 object.size(acs_m_db)
-
## 10544 bytes
-

Note that though many commands behave exactly the same whether on a local data.frame or database, sometimes more advanced / complicated syntax around variable modification allowed in dplyr does not work on a particular database and so it is better to be more explicit. For example, creating a variable inside of a summarize call does not work in some databases. .

+
## 10880 bytes
+

Note that though many commands behave exactly the same whether on a +local data.frame or database, sometimes more advanced / complicated +syntax around variable modification allowed in dplyr does not work on a +particular database and so it is better to be more explicit. For +example, creating a variable inside of a summarize call does not work in +some databases. .

 acs_m %>% 
   group_by(sex) %>%
@@ -195,14 +227,21 @@ 

group_by(sex) %>% mutate(hicov = ifelse(hicov == 1, 1L, 0L)) %>% summarize(hicov = mean(hicov))

-
## # Source:   lazy query [?? x 2]
+
## # Source:   SQL [2 x 2]
 ## # Database: sqlite 3.37.0 [:memory:]
 ##     sex hicov
 ##   <int> <dbl>
 ## 1     1 0.858
 ## 2     2 0.895
-

Further, sometimes working with variable types can get difficult if you are used to working in R. Notice how in the above, instead of hicov = (hicov == 1), I wrote out the ifelse statement. If I hadn’t RSQLite would be unable to calculate the mean of the boolean variable created.

-

Finally, a major difference when transitioning from dplyr on local data.frames is that not all R functions are translated to SQL. For example, cut() isn’t implemented in SQL, so you can’t create a new variable in the data.frame using it.

+

Further, sometimes working with variable types can get difficult if +you are used to working in R. Notice how in the above, instead of +hicov = (hicov == 1), I wrote out the ifelse statement. If +I hadn’t RSQLite would be unable to calculate the mean of the boolean +variable created.

+

Finally, a major difference when transitioning from dplyr on local +data.frames is that not all R functions are translated to SQL. For +example, cut() isn’t implemented in SQL, so you can’t +create a new variable in the data.frame using it.

 acs_m %>% 
   group_by(agecat = cut(agep, c(0, 19, 35, 50, 65, 200))) %>%
@@ -233,7 +272,7 @@ 

ifelse(agep >= 65, "65+", NA)))))) %>% group_by(agecat) %>% summarize(hicov = mean(hicov))

-
## # Source:   lazy query [?? x 2]
+
## # Source:   SQL [5 x 2]
 ## # Database: sqlite 3.37.0 [:memory:]
 ##   agecat hicov
 ##   <chr>  <dbl>
@@ -242,12 +281,17 @@ 

## 3 35-49 1.17 ## 4 50-64 1.13 ## 5 65+ 1.01

-

For more information on the specifics of databases with dplyr, see vignette("database", package = "dplyr"), the DBI package or the specific database packages, like RSQLite.

+

For more information on the specifics of databases with dplyr, see +vignette("database", package = "dplyr"), the +DBI package or the specific database packages, like +RSQLite.

Srvyr Setup

-

Srvyr commands are nearly identical to old. The only difference for setup is that you need a variable that uniquely identifies each row in the database (uid).

+

Srvyr commands are nearly identical to old. The only difference for +setup is that you need a variable that uniquely identifies each row in +the database (uid).

 acs_m_db_svy <- acs_m_db %>% 
   as_survey_rep(
@@ -284,16 +328,24 @@ 

## (int), pwgtp73 (int), pwgtp74 (int), pwgtp75 (int), pwgtp76 (int), pwgtp77 ## (int), pwgtp78 (int), pwgtp79 (int), pwgtp80 (int), agep (int), hicov (int), ## sex (int), st (chr), rt (chr)

-

Because srvyr stores the survey variables locally, the srvyr object takes up much more memory than the dplyr one. However, this object would not grow in size if you added more data variables to your survey, so if your survey is very wide, it will save a lot space.

+

Because srvyr stores the survey variables locally, the srvyr object +takes up much more memory than the dplyr one. However, this object would +not grow in size if you added more data variables to your survey, so if +your survey is very wide, it will save a lot space.

 object.size(acs_m_db_svy)
-
## 8391576 bytes
+
## 8391912 bytes

Analysis

-

Analysis commands from srvyr are also similar to ones that work on local data.frames. The main differences come from the issues discussed above about explicitly creating variables difficulties in translating R commands, and variable types.

-

The following analysis is based on the asdfree analysis and shows some basic analysis on the total population, insurance coverage, age and sex.

+

Analysis commands from srvyr are also similar to ones that work on +local data.frames. The main differences come from the issues discussed +above about explicitly creating variables difficulties in translating R +commands, and variable types.

+

The following analysis is based on the asdfree analysis and shows +some basic analysis on the total population, insurance coverage, age and +sex.

 # You can calculate the population of the united states #
 # by state
@@ -344,7 +396,7 @@ 

mutate(hicov = as.character(hicov)) %>% group_by(st, hicov) %>% summarize(pct = survey_mean(na.rm = TRUE))

-
## Adding missing grouping variables: `st`, `hicov`
+
## Adding missing grouping variables: `st` and `hicov`
## # A tibble: 4 × 4
 ## # Groups:   st [2]
 ##   st    hicov    pct  pct_se
@@ -414,7 +466,10 @@ 

Running survey commands with collect

-

If you’d like to run a command from the survey package, you’ll need to collect the data locally first. You can select only the variables you’ll need for the analysis so that you don’t have to store the whole dataset in memory.

+

If you’d like to run a command from the survey package, you’ll need +to collect the data locally first. You can select only the variables +you’ll need for the analysis so that you don’t have to store the whole +dataset in memory.

 acs_m_db_svy %>%
   select(agep, hicov, sex) %>%
@@ -494,7 +549,11 @@ 

Write Access

-

Note that srvyr does not require write access to perform calculations, the database created in this vignette was set to read-only at the beginning. This can be important when you want to make sure that your original data is not altered accidentally, or if you don’t have write access to a database.

+

Note that srvyr does not require write access to perform +calculations, the database created in this vignette was set to read-only +at the beginning. This can be important when you want to make sure that +your original data is not altered accidentally, or if you don’t have +write access to a database.

diff --git a/docs/articles/srvyr-vs-survey.html b/docs/articles/srvyr-vs-survey.html index a68f154..8f8fef4 100644 --- a/docs/articles/srvyr-vs-survey.html +++ b/docs/articles/srvyr-vs-survey.html @@ -32,7 +32,7 @@ srvyr - 1.1.1 + 1.1.2

@@ -93,10 +93,11 @@
diff --git a/docs/reference/index.html b/docs/reference/index.html index 1fb9159..e53c521 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -72,7 +72,7 @@ srvyr - 1.1.1 + 1.1.2
@@ -184,7 +184,8 @@

Calculate summary statistics of survey data

-

Functions for calculating summary measures taking into account complex survey design

+

Functions for calculating summary measures taking into account +complex survey design

diff --git a/docs/reference/interact.html b/docs/reference/interact.html index be29336..c535b34 100644 --- a/docs/reference/interact.html +++ b/docs/reference/interact.html @@ -75,7 +75,7 @@ srvyr - 1.1.1 + 1.1.2

diff --git a/docs/reference/pipe.html b/docs/reference/pipe.html index 481fc11..8c70bba 100644 --- a/docs/reference/pipe.html +++ b/docs/reference/pipe.html @@ -73,7 +73,7 @@ srvyr - 1.1.1 + 1.1.2 diff --git a/docs/reference/reexports.html b/docs/reference/reexports.html index c5142d8..f9d1024 100644 --- a/docs/reference/reexports.html +++ b/docs/reference/reexports.html @@ -78,7 +78,7 @@ srvyr - 1.1.1 + 1.1.2 diff --git a/docs/reference/rlang-tidyeval.html b/docs/reference/rlang-tidyeval.html index 930da93..ebfe87f 100644 --- a/docs/reference/rlang-tidyeval.html +++ b/docs/reference/rlang-tidyeval.html @@ -76,7 +76,7 @@ srvyr - 1.1.1 + 1.1.2 diff --git a/docs/reference/set_survey_vars.html b/docs/reference/set_survey_vars.html index 755eb12..cd95137 100644 --- a/docs/reference/set_survey_vars.html +++ b/docs/reference/set_survey_vars.html @@ -78,7 +78,7 @@ srvyr - 1.1.1 + 1.1.2 diff --git a/docs/reference/srvyr-se-deprecated.html b/docs/reference/srvyr-se-deprecated.html index 6509026..7f308a1 100644 --- a/docs/reference/srvyr-se-deprecated.html +++ b/docs/reference/srvyr-se-deprecated.html @@ -77,7 +77,7 @@ srvyr - 1.1.1 + 1.1.2 diff --git a/docs/reference/srvyr.html b/docs/reference/srvyr.html index 895ef70..f2283bd 100644 --- a/docs/reference/srvyr.html +++ b/docs/reference/srvyr.html @@ -76,7 +76,7 @@ srvyr - 1.1.1 + 1.1.2 diff --git a/docs/reference/srvyr_interaction.html b/docs/reference/srvyr_interaction.html index 5a98f16..046167c 100644 --- a/docs/reference/srvyr_interaction.html +++ b/docs/reference/srvyr_interaction.html @@ -76,7 +76,7 @@ srvyr - 1.1.1 + 1.1.2 diff --git a/docs/reference/summarise.html b/docs/reference/summarise.html index 032da76..3ed348d 100644 --- a/docs/reference/summarise.html +++ b/docs/reference/summarise.html @@ -73,7 +73,7 @@ srvyr - 1.1.1 + 1.1.2 diff --git a/docs/reference/summarise_all.html b/docs/reference/summarise_all.html index 14e1d5f..9409415 100644 --- a/docs/reference/summarise_all.html +++ b/docs/reference/summarise_all.html @@ -74,7 +74,7 @@ srvyr - 1.1.1 + 1.1.2 diff --git a/docs/reference/survey_mean.html b/docs/reference/survey_mean.html index 32b027c..39ee73b 100644 --- a/docs/reference/survey_mean.html +++ b/docs/reference/survey_mean.html @@ -76,7 +76,7 @@ srvyr - 1.1.1 + 1.1.2 @@ -319,10 +319,11 @@

Examp summarise(srvyr_default = survey_mean(api99, vartype = "ci"), survey_defualt = survey_mean(api99, vartype = "ci", df = Inf))
#> # A tibble: 1 × 6 -#> srvyr_default srvyr_default_low srvyr_default_upp survey_defualt -#> <dbl> <dbl> <dbl> <dbl> -#> 1 629. 609. 649. 629. -#> # … with 2 more variables: survey_defualt_low <dbl>, survey_defualt_upp <dbl>
+#> srvyr_default srvyr_default_low srvyr_default_upp survey_def…¹ surve…² surve…³ +#> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> +#> 1 629. 609. 649. 629. 610. 649. +#> # … with abbreviated variable names ¹​survey_defualt, ²​survey_defualt_low, +#> # ³​survey_defualt_upp
comparison <- survey::svymean(~api99, dstrata) confint(comparison) # survey's default
#> 2.5 % 97.5 % diff --git a/docs/reference/survey_old_quantile.html b/docs/reference/survey_old_quantile.html index 4648266..2fbd904 100644 --- a/docs/reference/survey_old_quantile.html +++ b/docs/reference/survey_old_quantile.html @@ -79,7 +79,7 @@ srvyr - 1.1.1 + 1.1.2
@@ -246,10 +246,11 @@

Examp summarise(api99 = survey_old_quantile(api99, c(0.25, 0.5, 0.75)), api00 = survey_old_median(api00, vartype = c("ci")))
#> # A tibble: 1 × 9 -#> api99_q25 api99_q50 api99_q75 api99_q25_se api99_q50_se api99_q75_se api00 -#> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> -#> 1 525. 631 727. 12.5 18.4 17.9 667. -#> # … with 2 more variables: api00_low <dbl>, api00_upp <dbl>
+#> api99_q25 api99_q50 api99_q75 api99_q2…¹ api99…² api99…³ api00 api00…⁴ api00…⁵ +#> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> +#> 1 525. 631 727. 12.5 18.4 17.9 667. 636. 682. +#> # … with abbreviated variable names ¹​api99_q25_se, ²​api99_q50_se, +#> # ³​api99_q75_se, ⁴​api00_low, ⁵​api00_upp
dstrata %>% group_by(awards) %>% summarise(api00 = survey_old_median(api00)) diff --git a/docs/reference/survey_quantile.html b/docs/reference/survey_quantile.html index f7f0dd0..3af2fc9 100644 --- a/docs/reference/survey_quantile.html +++ b/docs/reference/survey_quantile.html @@ -75,7 +75,7 @@ srvyr - 1.1.1 + 1.1.2
@@ -235,10 +235,11 @@

Examp summarise(api99 = survey_quantile(api99, c(0.25, 0.5, 0.75)), api00 = survey_median(api00, vartype = c("ci")))
#> # A tibble: 1 × 9 -#> api99_q25 api99_q50 api99_q75 api99_q25_se api99_q50_se api99_q75_se api00 -#> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> -#> 1 526 631 728 13.7 17.5 18.3 668 -#> # … with 2 more variables: api00_low <dbl>, api00_upp <dbl>
+#> api99_q25 api99_q50 api99_q75 api99_q2…¹ api99…² api99…³ api00 api00…⁴ api00…⁵ +#> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> +#> 1 526 631 728 13.7 17.5 18.3 668 641 695 +#> # … with abbreviated variable names ¹​api99_q25_se, ²​api99_q50_se, +#> # ³​api99_q75_se, ⁴​api00_low, ⁵​api00_upp
dstrata %>% group_by(awards) %>% summarise(api00 = survey_median(api00)) diff --git a/docs/reference/survey_ratio.html b/docs/reference/survey_ratio.html index e5ee6c2..625911f 100644 --- a/docs/reference/survey_ratio.html +++ b/docs/reference/survey_ratio.html @@ -75,7 +75,7 @@ srvyr - 1.1.1 + 1.1.2
@@ -235,10 +235,11 @@

Examp summarise(srvyr_default = survey_total(api99, vartype = "ci"), survey_defualt = survey_total(api99, vartype = "ci", df = Inf))
#> # A tibble: 1 × 6 -#> srvyr_default srvyr_default_low srvyr_default_upp survey_defualt -#> <dbl> <dbl> <dbl> <dbl> -#> 1 3898472. 3775136. 4021807. 3898472. -#> # … with 2 more variables: survey_defualt_low <dbl>, survey_defualt_upp <dbl>
+#> srvyr_default srvyr_default_low srvyr_default_upp survey_def…¹ surve…² surve…³ +#> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> +#> 1 3898472. 3775136. 4021807. 3898472. 3.78e6 4.02e6 +#> # … with abbreviated variable names ¹​survey_defualt, ²​survey_defualt_low, +#> # ³​survey_defualt_upp
comparison <- survey::svytotal(~api99, dstrata) confint(comparison) # survey's default
#> 2.5 % 97.5 % diff --git a/docs/reference/survey_tally.html b/docs/reference/survey_tally.html index f4d1eaf..9a2b0ea 100644 --- a/docs/reference/survey_tally.html +++ b/docs/reference/survey_tally.html @@ -77,7 +77,7 @@ srvyr - 1.1.1 + 1.1.2
diff --git a/docs/reference/survey_total.html b/docs/reference/survey_total.html index 008748b..9a03c55 100644 --- a/docs/reference/survey_total.html +++ b/docs/reference/survey_total.html @@ -75,7 +75,7 @@ srvyr - 1.1.1 + 1.1.2 @@ -239,10 +239,11 @@

Examp summarise(srvyr_default = survey_total(api99, vartype = "ci"), survey_defualt = survey_total(api99, vartype = "ci", df = Inf))
#> # A tibble: 1 × 6 -#> srvyr_default srvyr_default_low srvyr_default_upp survey_defualt -#> <dbl> <dbl> <dbl> <dbl> -#> 1 3898472. 3775136. 4021807. 3898472. -#> # … with 2 more variables: survey_defualt_low <dbl>, survey_defualt_upp <dbl>
+#> srvyr_default srvyr_default_low srvyr_default_upp survey_def…¹ surve…² surve…³ +#> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> +#> 1 3898472. 3775136. 4021807. 3898472. 3.78e6 4.02e6 +#> # … with abbreviated variable names ¹​survey_defualt, ²​survey_defualt_low, +#> # ³​survey_defualt_upp
comparison <- survey::svytotal(~api99, dstrata) confint(comparison) # survey's default
#> 2.5 % 97.5 % diff --git a/docs/reference/survey_var.html b/docs/reference/survey_var.html index a1f75aa..4239e25 100644 --- a/docs/reference/survey_var.html +++ b/docs/reference/survey_var.html @@ -75,7 +75,7 @@ srvyr - 1.1.1 + 1.1.2
diff --git a/docs/reference/svychisq.html b/docs/reference/svychisq.html index 14a791d..a9a2810 100644 --- a/docs/reference/svychisq.html +++ b/docs/reference/svychisq.html @@ -73,7 +73,7 @@ srvyr - 1.1.1 + 1.1.2 diff --git a/docs/reference/tbl_svy.html b/docs/reference/tbl_svy.html index 5a2b9ea..fd3a792 100644 --- a/docs/reference/tbl_svy.html +++ b/docs/reference/tbl_svy.html @@ -75,7 +75,7 @@ srvyr - 1.1.1 + 1.1.2 diff --git a/docs/reference/tbl_vars.html b/docs/reference/tbl_vars.html index eb3e235..47824a2 100644 --- a/docs/reference/tbl_vars.html +++ b/docs/reference/tbl_vars.html @@ -73,7 +73,7 @@ srvyr - 1.1.1 + 1.1.2 diff --git a/docs/reference/uninteract.html b/docs/reference/uninteract.html index 52a7d3a..2888f4d 100644 --- a/docs/reference/uninteract.html +++ b/docs/reference/uninteract.html @@ -74,7 +74,7 @@ srvyr - 1.1.1 + 1.1.2 diff --git a/docs/reference/unweighted.html b/docs/reference/unweighted.html index 47de06f..7ccd5d5 100644 --- a/docs/reference/unweighted.html +++ b/docs/reference/unweighted.html @@ -77,7 +77,7 @@ srvyr - 1.1.1 + 1.1.2