Skip to content

Commit

Permalink
added @Seealso tags linking convert_params_to_summary_stats and conve…
Browse files Browse the repository at this point in the history
…rt_summmary_stats_to_params
  • Loading branch information
joshwlambert committed Jul 9, 2024
1 parent b6b3787 commit d74c15d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 0 deletions.
4 changes: 4 additions & 0 deletions R/convert_params.R
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
#' statistics used to convert to parameter(s). An example is the `mean`
#' and `sd` summary statistics for the lognormal (`lnorm`) distribution.
#'
#' @seealso [convert_params_to_summary_stats()]
#'
#' @return A list of either one or two elements (depending on how many
#' parameters the distribution has).
#' @export
Expand Down Expand Up @@ -154,6 +156,8 @@ convert_summary_stats_to_params.epidist <- function(x, ...) {
#' used to convert to summary statistics. An example is the `meanlog` and
#' `sdlog` parameters of the lognormal (`lnorm`) distribution.
#'
#' @seealso [convert_summary_stats_to_params()]
#'
#' @return A list of eight elements including: mean, median, mode,
#' variance (`var`), standard deviation (`sd`), coefficient of variation (`cv`),
#' skewness, and excess kurtosis (`ex_kurtosis`).
Expand Down
3 changes: 3 additions & 0 deletions man/convert_params_to_summary_stats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions man/convert_summary_stats_to_params.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d74c15d

Please sign in to comment.