- S3 Interface for MCS (#95)

- markdown for documentation (#173)

- closes #189

NAMESPACE

@@ -9,8 +9,14 @@ S3method(confint_fisher,wt_ml_estimation)
 S3method(confint_fisher,wt_model)
 S3method(dist_delay,default)
 S3method(dist_delay,wt_mcs_delay_data)
+S3method(dist_mileage,default)
+S3method(dist_mileage,wt_mcs_mileage_data)
 S3method(estimate_cdf,default)
 S3method(estimate_cdf,wt_reliability_data)
+S3method(mcs_delay,default)
+S3method(mcs_delay,wt_mcs_delay_data)
+S3method(mcs_mileage,default)
+S3method(mcs_mileage,wt_mcs_mileage_data)
 S3method(mixmod_em,default)
 S3method(mixmod_em,wt_reliability_data)
 S3method(mixmod_regression,default)
@@ -50,6 +56,7 @@ S3method(print,wt_delay_estimation_list)
 S3method(print,wt_em_results)
 S3method(print,wt_mcs_delay_data)
 S3method(print,wt_mcs_mileage_data)
+S3method(print,wt_mileage_estimation)
 S3method(print,wt_mixmod_em)
 S3method(print,wt_mixmod_regression)
 S3method(print,wt_mixmod_regression_list)

NEWS.md

@@ -1,28 +1,53 @@
 # weibulltools (development version)
 
 ## Breaking Changes
-* `confint_betabinom()` and `confint_fisher()`: Removed constant features `distribution`, `bounds` and `direction` from the tibble output and added them as attributes instead.
+
+### Parametric Models
 * `plot_prob.wt_model()`: Removed dysfunctional argument `distribution`. The distribution is inferred using the model `x`.
+
+### Confidence Intervals
+* `confint_betabinom()` and `confint_fisher()`: Removed constant features `distribution`, `bounds` and `direction` from the tibble output and added them as attributes instead.
+
+### Monte Carlo Simulation
 * `mcs_mileage()`: Changed name of output column `mileage` to `x` (in accordance with `reliability_data()`).
 * `mcs_delay()`: Changed name of output column `time` to `x` (in accordance with `reliability_data()`). 
+* `dist_mileage.default()` (former `dist_mileage()`): Renamed argument `mileage` with `x`.
+* `mcs_mileage.default()` (former `mcs_mileage()`): Renamed argument `mileage` with `x`.
 
 ## New Features
+
+### Confidence Intervals
+* `confint_betabinom()`: Methods `"kaplan"` and `"nelson"` of `estimate_cdf()` can be used for beta-binomial confidence bounds.
+
+### Monte Carlo Simulation
+* Added `mcs_mileage_data()`: Create consistent MCS data for `mcs_mileage()`.
+* Added `mcs_delay_data()`: Create consistent MCS data for `mcs_delay()`.
+* `dist_mileage()` is now an S3 generic. `dist_mileage()` becomes `dist_mileage.default()`. Added `dist_mileage.wt_mcs_mileage_data()`.
 * `dist_delay()` is now an S3 generic. `dist_delay()` becomes `dist_delay.default()`. Added `dist_delay.wt_mcs_delay_data()`.
-* Added `print.wt_delay_estimation()` for one delay and and `print.wt_delay_estimation_list()` for multiple delays.
 * `dist_delay()` now supports the estimation of multiple delay distributions at once. 
+* `mcs_mileage()` is now an S3 generic. `mcs_mileage()` becomes `mcs_mileage.default()`. Added `mcs_mileage.wt_mcs_mileage_data()`.
+* `mcs_delay()` is now an S3 generic. `mcs_delay()` becomes `mcs_delay.default()`. Added `mcs_delay.wt_mcs_delay_data()`.
 * Added `print.wt_mcs_delay_data()` and `print.wt_mcs_mileage_data()`.
-* Added `mcs_delay_data()`: Create consistent MCS data for `mcs_delay()`.
-* Added `mcs_mileage_data()`: Create consistent MCS data for `mcs_mileage()`.
-* `confint_betabinom()`: Methods `"kaplan"` and `"nelson"` of `estimate_cdf()` can be used for beta-binomial confidence bounds. 
+* Added `print.wt_mileage_estimation()`. 
+* Added `print.wt_delay_estimation()` for one delay and `print.wt_delay_estimation_list()` for multiple delays.
 
 ## Minor Improvements and bug fixes
-* The object returned by `dist_delay()` now has class `wt_delay_estimation` or `wt_delay_estimation_list`. 
-* Fixed bug in `plot_conf()`: Wrong confidence bounds were displayed for `direction = "x"` (#181). 
-* Fixed bug in `plot_conf()`: `plot_method = "ggplot2"` and exactly one method in `estimate_cdf()` resulted in an error (#182).
+
+### Reliability Data 
 * Fixed bug in `reliability_data()`: Using `!!` syntax with arguments `x` and `status` resulted in an error.
 * `estimate_cdf()` preserves additional columns, that were returned from `reliability_data(..., .keep_all = TRUE)`.
 * Improved `print.wt_reliability_data()`.
 
+### Confidence Intervals
+* Fixed bug in `plot_conf()`: Wrong confidence bounds were displayed for `direction = "x"` (#181). 
+* Fixed bug in `plot_conf()`: `plot_method = "ggplot2"` and exactly one method in `estimate_cdf()` resulted in an error (#182).
+
+### Monte Carlo Simulation
+* The object returned by `mcs_mileage()` now has class `wt_mcs_mileage`.
+* The object returned by `mcs_delay()` now has class `wt_mcs_delay`. 
+* The object returned by `dist_mileage()` now has class `wt_mileage_estimation`. 
+* The object returned by `dist_delay()` now has class `wt_delay_estimation` or `wt_delay_estimation_list`. 
+
 ## Documentation improvements
 * `plot_prob()`: Better work out the distinction between `plot_prob.wt_cdf_estimation()` and `plot_prob.wt_model()`. The former is applied to a CDF estimation whereas the latter is applied to a mixture model.