Skip to contents

Extract internal survey design object for advanced use

Source: R/survey-bridge.R
as_survey_design.Rd

Provides power users with direct access to the internal survey.design2 object for advanced analysis using survey package functions. This is an escape hatch for workflows not yet wrapped by tidycreel. Most users should use estimate_effort() instead.

The function issues a once-per-session warning to educate users that this is an advanced feature with risks if the returned object is modified incorrectly.

Usage

as_survey_design(design)

Arguments

design

A creel_design object with counts attached via add_counts

Value

A survey.design2 object (from survey::svydesign). Due to R's copy-on-modify semantics, modifications to the returned object will not affect the internal design$survey object.

Warning

This function issues a once-per-session warning explaining:

  • This is an advanced feature for power users

  • Most users should use estimate_effort() instead

  • Modifying the survey design may produce incorrect variance estimates

See also

Other "Survey Design": add_catch(), add_counts(), add_interviews(), add_lengths(), add_sections(), as_hybrid_svydesign(), compute_angler_effort(), compute_effort(), creel_design(), creel_schema(), est_effort_camera(), prep_counts_boat_party(), prep_counts_daily_effort(), prep_interview_catch(), prep_interviews_trips(), validate_creel_schema()

Examples

# Basic workflow
library(survey)
#> Loading required package: grid
#> Loading required package: Matrix
#> Loading required package: survival
#> 
#> Attaching package: ‘survey’
#> The following object is masked from ‘package:graphics’:
#> 
#>     dotchart
cal <- data.frame(
  date = as.Date(c("2024-06-01", "2024-06-02", "2024-06-03", "2024-06-04")),
  day_type = c("weekday", "weekday", "weekend", "weekend")
)
design <- creel_design(cal, date = date, strata = day_type)

counts <- data.frame(
  date = as.Date(c("2024-06-01", "2024-06-02", "2024-06-03", "2024-06-04")),
  day_type = c("weekday", "weekday", "weekend", "weekend"),
  count = c(15, 23, 45, 52)
)

design2 <- add_counts(design, counts)
#> Warning: No weights or probabilities supplied, assuming equal probability

# Extract survey object for advanced use
svy <- as_survey_design(design2)
#> Warning: Accessing internal survey design object.
#> ℹ This is an advanced feature. Most users should use {.fn estimate_effort} instead.
#> ! Modifying the survey design may produce incorrect variance estimates.
#> This warning is displayed once per session.

# Use with survey package functions
survey::svytotal(~count, svy)
#>       total    SE
#> count   135 10.63
survey::svymean(~count, svy)
#>        mean     SE
#> count 33.75 2.6575