Skip to content

Commit

Permalink
Remove text on generic functions in extract_convert.Rmd
Browse files Browse the repository at this point in the history
Co-authored-by: James Azam <[email protected]>
  • Loading branch information
joshwlambert and jamesmbaazam authored Jul 9, 2024
1 parent b0676b6 commit 30130cf
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion vignettes/extract_convert.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ There are two conversion functions in {epiparameter}: `convert_params_to_summary

### Conversion functions

The conversion functions are generic functions. That means that different types of data can be supplied to the first argument and the correct operation (method) will be executed. Currently {epiparameter} provides conversion methods for `character` and `<epidist>`. If this is unclear, see the examples below for how the conversion functions can work when you supply either a `character` string or an `<epidist>`.
The conversion functions can take two types of inputs as the first argument: a `character` string of the distribution or an `<epidist>` object.

The conversion functions have two arguments. The first (`x`) defines which distribution you want to use and the second (`...`) lets you put as many named parameters or summary statistics as required. The arguments passed into `...` are matched by name, and therefore need to match exactly to the names expected. See the function documentation (`?convert_params_to_summary_stats` and `?convert_summary_stats_to_params` for names). In the case that an `<epidist>` object is supplied, if it has the parameters or summary statistics required for conversion then nothing needs to be given as extra arguments (i.e. `...`).

Expand Down

0 comments on commit 30130cf

Please sign in to comment.