export_options: Export options
In DanChaltiel/nih.joinpoint: R Interface for NIH's Joinpoint Regression Software

View source: R/options_export.R

export_options

R Documentation

Export options

Description

Create a character representation of the .ini file needed for export options.

Usage

export_options(
  models = c("best fit", "all"),
  remove_jp_flags = TRUE,
  remove_best_fit_flags = FALSE,
  output_bygroup_headers = FALSE,
  all_models_in_same_column = FALSE,
  include_jp_estimates = FALSE,
  include_apcs = TRUE,
  x_precision = 9,
  y_precision = 9,
  model_precision = 3,
  estimated_joinpoint_precision = 3,
  regression_coefficients_precision = 3,
  covariance_matrix_precision = 3,
  correlation_matrix_precision = 3,
  apc_precision = 3,
  aapc_precision = 3,
  aapc_segment_ranges_precision = 3,
  pvalue_precision = 3,
  aapc_full_range = FALSE,
  aapc_start_range1 = NULL,
  aapc_end_range1 = NULL,
  aapc_start_range2 = NULL,
  aapc_end_range2 = NULL,
  aapc_start_range3 = NULL,
  aapc_end_range3 = NULL,
  aapc_last_obs = FALSE,
  export_bad_cohorts = TRUE,
  export_report = TRUE,
  export_data = TRUE,
  export_apc = TRUE,
  export_aapc = TRUE,
  export_ftest = TRUE,
  export_pairwise = TRUE,
  export_jump_cr = TRUE
)

Arguments

`models`	one of `c("best fit", "all")`. Using `all` might be insightful but rather messes with the output.
`remove_jp_flags`	remove_jp_flags
`remove_best_fit_flags`	removes the `final_selected_model` column
`output_bygroup_headers`	should only be used if `models==best`. If `FALSE`, result table has `model`, `apc`, `joinpoints`. If `TRUE`, result table has `jp2`, `apc2` (if selected model is with 2 joinpoints) but rather messes with the output.
`all_models_in_same_column`	all_models_in_same_column
`include_jp_estimates`	include_jp_estimates
`include_apcs`	include_apcs
`x_precision`	x_precision
`y_precision`	y_precision
`model_precision`	model_precision
`estimated_joinpoint_precision`	estimated_joinpoint_precision
`regression_coefficients_precision`	regression_coefficients_precision
`covariance_matrix_precision`	covariance_matrix_precision
`correlation_matrix_precision`	correlation_matrix_precision
`apc_precision`	apc_precision
`aapc_precision`	aapc_precision
`aapc_segment_ranges_precision`	aapc_segment_ranges_precision
`pvalue_precision`	pvalue_precision
`aapc_full_range`	aapc_full_range
`aapc_start_range1`	aapc_start_range1
`aapc_end_range1`	aapc_end_range1
`aapc_start_range2`	aapc_start_range2
`aapc_end_range2`	aapc_end_range2
`aapc_start_range3`	aapc_start_range3
`aapc_end_range3`	aapc_end_range3
`aapc_last_obs`	aapc_last_obs
`export_bad_cohorts`	export_bad_cohorts
`export_report`	export_report
`export_data`	export_data
`export_apc`	export_apc
`export_aapc`	export_aapc
`export_ftest`	export_ftest
`export_pairwise`	export_pairwise
`export_jump_cr`	export_jump_cr