Skip to contents

Get hetid package options with fallback to constants

Source: R/options.R
hetid_opt.Rd

This function retrieves user-configurable options for the hetid package. If a user hasn't set a specific option, it falls back to the default value stored in the package's internal constants environment.

Usage

hetid_opt(option_name)

Arguments

option_name

Character. Name of the option to retrieve. Supported options include:

  • display_digits: Number of digits for displaying results

  • alpha_level: Significance level for statistical tests

  • weak_f_threshold: F-statistic threshold for weak instruments

  • parallel_offset: Offset for parallel processing workers

  • bootstrap_reps: Number of bootstrap replications

Value

The option value. Returns the user-set value if available, otherwise returns the default from the constants environment.

Examples

# Get default display digits
hetid_opt("display_digits")
#> [1] 4

# Set a custom value
options(hetid.display_digits = 6)
hetid_opt("display_digits")
#> [1] 6

# Reset to default
options(hetid.display_digits = NULL)
hetid_opt("display_digits")
#> [1] 4