The first step is to either load the pre-calculated curve in
.rds
format obtained in the dose-effect fitting module or
input the curve coefficients manually in case the user wants to use a
pre-existing curve calculated outside of Biodose Tools. Clicking on
“Preview data” will load the curve into the app and display it on the
“Results” tabbed box.
This step is accomplished in R by either using the results from
fit()
or by loading an existing .rds
object
via readRDS()
:
<- system.file("extdata", "dicentrics-fitting-results.rds",
fit_results package = "biodosetools") %>%
readRDS()
$fit_coeffs
fit_results#> estimate std.error statistic p.value
#> coeff_C 0.001280319 0.0004714055 2.715961 6.608367e-03
#> coeff_alpha 0.021038724 0.0051576170 4.079156 4.519949e-05
#> coeff_beta 0.063032534 0.0040073856 15.729091 9.557291e-56
Next we can choose to either load the case data from a file
(supported formats are .csv
, .dat
, and
.txt
) or to input the data manually. Once the table is
generated and filled, the “Calculate parameters” button will calculate
the total number of cells (\(N\)),
total number of aberrations (\(X\)), as
well as mean (\(\bar{y}\)), standard
error (\(\sigma\)), dispersion index
(\(\sigma^{2}/\bar{y}\)), and \(u\)-value.
This step is accomplished in R by calling the
calculate_aberr_table()
function:
<- system.file("extdata", "cases-data-partial.csv", package = "biodosetools") %>%
case_data ::read.csv(header = TRUE) %>%
utilscalculate_aberr_table(
type = "case",
assessment_u = 1,
aberr_module = "dicentrics"
)
case_data#> # A tibble: 1 × 12
#> N X C0 C1 C2 C3 C4 C5 y y_err DI u
#> <int> <int> <int> <int> <int> <int> <int> <int> <dbl> <dbl> <dbl> <dbl>
#> 1 361 100 302 28 22 8 1 0 0.277 0.0368 1.77 10.4
The final step is to select the dose estimation options. In the “Dose estimation options” box we can select type of exposure (acute, protracted, and highly protracted), type of assessment (whole-body, partial-body, or heterogeneous), and error methods for each type of assessment.
To perform the dose estimation in R we can call the adequate
estimate_*()
functions. In this example, we will use
estimate_whole_body_merkle()
and
estimate_partial_body_dolphin()
. First of all, however, we
will need to load the fit coefficients and variance-covariance
matrix:
<- fit_results[["fit_coeffs"]]
fit_coeffs <- fit_results[["fit_var_cov_mat"]] fit_var_cov_mat
After that is done, we can simply call
estimate_whole_body_merkle()
and
estimate_partial_body_dolphin()
:
<- estimate_whole_body_merkle(
results_whole_merkle
case_data,
fit_coeffs,
fit_var_cov_mat,conf_int_yield = 0.83,
conf_int_curve = 0.83,
protracted_g_value = 1,
aberr_module = "dicentrics"
)
<- estimate_partial_body_dolphin(
results_partial
case_data,
fit_coeffs,
fit_var_cov_mat,conf_int = 0.95,
gamma = 1 / 2.7,
aberr_module = "dicentrics"
)
To visualise the estimated doses, we call the
plot_estimated_dose_curve()
function:
plot_estimated_dose_curve(
est_doses = list(
whole = results_whole_merkle,
partial = results_partial
),
fit_coeffs,
fit_var_cov_mat,protracted_g_value = 1,
conf_int_curve = 0.95,
aberr_name = "Dicentrics"
)