Skip to content

Parameter reference guide

Fred Jaya edited this page Feb 16, 2024 · 2 revisions

Analyse

Design

Design initialisation

These selections are mandatory. They are used to configure the interface with the correct settings that align with the specific analysis and survey goals.


Name: Survey objective
label_id: optsObjective
Type: dropdown
Required: true
Default: na
Options: ["Estimate prevalence", "Detect pathogen"]

Description:
Survey objective defines the primary goal of the survey to being designed or analysed.

  • Estimate prevalence - Choose this option if the surveys primary aim is to estimate the prevalence of a marker or condition within the population under study.
  • Detect pathogen - Feature to be added.

Name: Survey mode
label_id: optsMode
Type: dropdown
Required: true
Default: na
Options: ["Identify cost-effective designs", "Calculate power of existing designs"]

Description:
Survey mode determines the primary objective of the analysis to be completed.

  • Identify cost-effective designs - This option utilises PoolPower::optimise_sN_prevalence() to explore different survey designs to find the most cost-effective approach, tailored to the performance of a pooled test. The sampling strategy that offers the best balance between accuracy and resource expenditure is output.
  • Calculate power of existing designs - Feature to be added.

Name: Collection strategy
label_id: optsTrapping
Type: dropdown
Required: true
Default: na
Options: ["Fixed sample size", "Fixed sampling period"]

Description:
Collection strategy determines how the samples should be pooled in the survey, accounting for resource or time constraints.

  • Fixed sample size - This option is preferred when the primary goal is to collect a specific number of samples, regardless of the time it takes. It is suitable for surveys where reaching a predetermined sample count is required.
  • Fixed sampling period - Choose this option when the survey is time-bound, where sampling is conducted multiple times over a period of time.