Recent Releases of ssdtools v2
ssdtools v2 - ssdtools 2.2.0
- Added
ssd_label_comma_hc()function to label numbers with significant digits and comma and offset hazard concentration value if present in breaks. - Added
ssd_dists_shiny()to define distributions for use in shiny app. - For
plot_coord_scale()function:- Added
x_limits = NULLto allow setting of x-axis limits. - Added
hc_value = NULLto pass hazard concentration value. - Restricted
transargument to"identity","log10"or "log".
- Added
- For
ssd_plot()function:- Added
text_sizeargument. - Added
theme_classic = FALSEargument to switch classic theme. - Soft-deprecated
sizeargument forlabel_size.
- Added
- Turned off x-axis minor breaks for all plots (for consistency) as HC major break causing multiple minor breaks in
ssd_plot().
Scientific Software - Peer-reviewed
- R
Published by joethorley 12 months ago
ssdtools v2 - ssdtools v2.1.0
- Added
ssd_xxmulti_fitdists()functions to accept object of classfitdists. - Set
ssd_xxmulti(..., lnorm.weight = 0)(instead of 1) to avoid incorrect values withdo.call("ssd_xxmulti", c(..., estimates(fits))iffitsdoes not include the log-normal distribution.
Scientific Software - Peer-reviewed
- R
Published by joethorley about 1 year ago
ssdtools v2 - ssdtools v2.0.0
ssdtools v2.0.0, which now includes David Fox and Rebecca Fisher as co-authors, is the second major release of ssdtools.
Major Changes
The following changes are major in the sense that they could alter previous hazard concentrations or break code.
Model Fitting and Averaging
Modifications
The following arguments were added to ssd_hc() and ssd_hp()
multi_est = TRUEto calculate model averaged estimates treating the distributions as constituting a single mixture distribution (previously it was effectivelyFALSE).method_ci = "weighted_samples"to specify whether to use"weighted_samples","weighted_arithmetic","multi_free"or"multi_fixed"methods to generate confidence intervals (previously it was effectively"weighted_arithmetic").
In addition the data frame returned by ssd_hc() and predict() now includes a column proportion with values between 0 and 1 as opposed to a column percentage with between 0 and 100.
Finally, with censored data confidence intervals can now only be estimated by non-parametric bootstrapping as the methods of parametrically bootstrapping censored data require review.
Minor Changes
The remaining changes are minor.
Model Fitting
Modifications
The following arguments of ssd_fit_dists() were changed to reduce the chances of the lnorm_lnorm bimodal distribution being dropped from the default set:
min_pmix = ssd_min_pmix(nrow(data))so that by defaultmin_pmixis 0.1 or3/nrow(data)if greater.at_boundary_ok = TRUE.computable = TRUE.
These changes also allowed the min_pboot = 0.95 argument to be changed from 0.80 for all bootstrapping functions.
It is worth noting that the second two changes also reduce the chances of the BurrIII distribution being dropped.
In addition rescale = TRUE now divides by the geometric mean of the minimum and maximum positive finite values as opposed to dividing by the geometric mean of the maximum finite value to improve the chances of convergence although ssd_fit_bcanz() no longer rescales by default.
Other minor modifications to the model fitting functions include
estimates.fitdists()now includes weights in returned parameters as well as anall_estimates = FALSEargument to allow parameter values for all implemented distributions to be included.delta = 7instead ofdelta = 9.21to ensure weight of included models at least 0.01.- seeds are now allocated to bootstrap samples as opposed to distributions (which results in a speed gain when there are more cores than the number of distributions).
lnormandgompertzinitial values are offset from their maximum likelihood estimates to avoid errors inoptim().
The following functions and arguments were also added:
ssd_hp_bcanz()andssd_hp.fitburrlioz()to get hazard proportions.ssd_pmulti(),ssd_qmulti()andssd_rmulti()for combined mixture distributions.ssd_exx()functions to get default parameter estimates for distributions.ssd_censor_data()to censor data.npars = c(2L, 5L)argument tossd_dists_bcanz()to specify the number of parameters.dists = ssd_dists_bcanz()tossd_fit_bcanz()to allow other packages to modify.samples = FALSEtossd_hc()andssd_hp()include bootstrap samples as list of numeric vector(s).save_to = NULLtossd_hc()andssd_hp()to specify a directory in which to save the bootstrap datasets as csv files and parameter estimates as .rds files.
Fixes
ssd_hc()andssd_hp()now return data frame withparametriccolumn.ssd_hp()now return data frame withwtcolumn.
Deprecations
The following functions and arguments were deprecated:
ssd_wqg_bc()andssd_wqg_burrlioz()were deprecated.percent = 5inssd_hc()andpredict()was soft-deprecated forproportion = 0.05.is_censored()is now defunct.
Plotting
Perhaps the biggest plotting change is that ssd_plot_cdf() now plots the average SSD together with the individual distributions if average = NA.
In addition, the following functions and arguments were added.
scale_fill_ssd()for color-blind fill scale.ssd_label_comma()for formatting of x-axis labels.trans = "log10"andadd_x = 0tossd_plot()andssd_plot_data()to control x-axis scale.big.mark = ","for x-axis labels andsuffix = "%"for y-axis labels to all plotting functions.
and the following functions deprecated
comma_signif()was soft-deprecated.is_censored(),plot.fitdists(),ssd_plot_cf()geom_ssd()andstat_ssd()are now defunct.
Data
The following data sets were removed
ccme_dataandccme_boron(available inssddatapackage).pearson1000data set.
Scientific Software - Peer-reviewed
- R
Published by joethorley about 1 year ago
ssdtools v2 -
- Released on CRAN
- Added contributors
- Added hex
Scientific Software - Peer-reviewed
- R
Published by joethorley about 7 years ago
ssdtools v2 -
Initial Release
Scientific Software - Peer-reviewed
- R
Published by joethorley over 7 years ago