Settings associated with a prevalence analysis

Usage

prevalenceSet(result)

Arguments

result: Result for which to get settings

Value

tibble with settings used when estimating prevalence

Examples

# \donttest{
cdm <- mockIncidencePrevalenceRef(sampleSize = 200)
cdm <- generateDenominatorCohortSet(cdm, name = "denominator")
#> ℹ Creating denominator cohorts
#> ✔ Cohorts created in 0 min and 3 sec
prev <- estimatePointPrevalence(
  cdm = cdm,
  denominatorTable = "denominator",
  outcomeTable = "outcome"
)
#> Getting prevalence for analysis 1 of 1
#> Time taken: 0 mins and 0 secs
prevalenceSet(prev)
#> Warning: `prevalenceSet()` was deprecated in IncidencePrevalence 0.6.2.
#> ℹ Please use `setings()` instead.
#> # A tibble: 1 × 19
#>   analysis_id outcome_cohort_id outcome_cohort_name analysis_type
#>   <chr>                   <int> <chr>               <chr>        
#> 1 1                           1 cohort_1            point        
#> # ℹ 15 more variables: analysis_interval <chr>,
#> #   analysis_complete_database_intervals <lgl>, analysis_time_point <chr>,
#> #   analysis_full_contribution <lgl>, analysis_min_cell_count <dbl>,
#> #   denominator_cohort_id <int>, denominator_cohort_name <chr>,
#> #   denominator_age_group <chr>, denominator_sex <chr>,
#> #   denominator_days_prior_observation <dbl>, denominator_start_date <date>,
#> #   denominator_end_date <date>, …
# }