Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix problems with rd files #118

Merged
merged 5 commits into from
Feb 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions R/data.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
#'
#' @format
#' A list containing the following elements:
#' \itemize{
#' \item{Survival}{ A data frame containing patient information and time to 3 separate survival endpoints.}
#' \describe{
#' \item{Survival}{A data frame containing patient information and time to 3 separate survival endpoints.}
#' \item{Costs}{A list of data frames. The first data frame contains medical cost data and the
#' second data frame contains drug cost data.}
#' }
Expand Down Expand Up @@ -52,12 +52,12 @@
#' are also included to facilitate cost-effectiveness analysis.
#' @format
#' A list containing the following elements:
#' \itemize{
#' \item{transitions}{ A data frame containing the times at which patient transitions between health states based
#' \describe{
#' \item{transitions}{A data frame containing the times at which patient transitions between health states based
#' on the [prothr][mstate::prothr] dataset from the [mstate][mstate::mstate] package.}
#' \item{costs}{ A list of data frames. The first data frame contains summary medical cost estimates and the
#' \item{costs}{A list of data frames. The first data frame contains summary medical cost estimates and the
#' second data frame contains drug cost data.}
#' \item{utility}{ A data frame of summary utility estimates.}
#' \item{utility}{A data frame of summary utility estimates.}
#' }
#'
#' @section Transitions data:
Expand Down Expand Up @@ -111,7 +111,7 @@
#'
#' @format
#' A list containing the following elements:
#' \itemize{
#' \describe{
#' \item{transitions}{ A data frame containing patient transitions between health
#' states at discrete time intervals (i.e., on a yearly basis).}
#' \item{costs}{ A list of data frames. The first data frame contains
Expand Down
12 changes: 6 additions & 6 deletions R/params.R
Original file line number Diff line number Diff line change
Expand Up @@ -112,12 +112,12 @@ summary_params_list <- function(object, prob = 0.95, idcol = "model", ...) {
#' @return An object prefixed by `params_`. Mapping between `create_params`
#' and the classes of the returned objects are:
#' \itemize{
#' \item{`create_params.lm` ->}{ [`params_lm`]}
#' \item{`create_params.multinom` ->}{ [`params_mlogit`]}
#' \item{`create_params.multinom_list` ->}{ [`params_mlogit_list`]}
#' \item{`create_params.flexsurvreg` ->}{ [`params_surv`]}
#' \item{`create_params.flexsurvreg_list` ->}{ [`params_surv_list`]}
#' \item{`create_params.partsurvfit` ->}{ [`params_surv_list`]}
#' \item `create_params.lm` -> [`params_lm`]
#' \item `create_params.multinom` -> [`params_mlogit`]
#' \item `create_params.multinom_list` -> [`params_mlogit_list`]
#' \item `create_params.flexsurvreg` -> [`params_surv`]
#' \item `create_params.flexsurvreg_list` -> [`params_surv_list`]
#' \item `create_params.partsurvfit` -> [`params_surv_list`]
#' }
#' @name create_params
#' @examples
Expand Down
4 changes: 2 additions & 2 deletions R/params_surv.R
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@
#' and the identity function if the parameter space is unrestricted.
#'
#' The types of distributions that can be specified are:
#' \itemize{
#' \describe{
#' \item{`exponential` or `exp`}{ Exponential distribution. `coef`
#' must contain the `rate` parameter on the log scale and the same parameterization as in
#' [`stats::Exponential`]}.
#' [`stats::Exponential`].}
#'
#' \item{`weibull` or `weibull.quiet`}{ Weibull distribution. The first
#' element of `coef` is the `shape` parameter (on the log scale) and the second
Expand Down
8 changes: 4 additions & 4 deletions R/sim-general.R
Original file line number Diff line number Diff line change
Expand Up @@ -663,9 +663,9 @@ sim_costs <- function(object, models, dr = .03,
#'
#' @format
#' A list containing two elements:
#' \itemize{
#' \item{`costs`}{ Total (discounted) costs by category.}
#' \item{`qalys`}{ (Discounted) quality-adjusted life-years.}
#' \describe{
#' \item{`costs`}{Total (discounted) costs by category.}
#' \item{`qalys`}{(Discounted) quality-adjusted life-years.}
#' }
#'
#' @section Costs:
Expand All @@ -692,4 +692,4 @@ sim_costs <- function(object, models, dr = .03,
#' }
#'
#' @name ce
NULL
NULL
2 changes: 0 additions & 2 deletions R/utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
#'
#' \code{check} is a generic function for validating the inputs of class objects.
#' @param object object to check.
#' @param inner_class When checking a list of objects, the class of elements within
#' the inner most list.
#' @param ... Further arguments passed to or from other methods.
#'
#' @return If validation is successful, returns the object in question; otherwise,
Expand Down
6 changes: 3 additions & 3 deletions man/ce.Rd

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

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

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

12 changes: 6 additions & 6 deletions man/create_params.Rd

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

8 changes: 4 additions & 4 deletions man/mstate3_exdata.Rd

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

2 changes: 1 addition & 1 deletion man/multinom3_exdata.Rd

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

4 changes: 2 additions & 2 deletions man/params_surv.Rd

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

4 changes: 2 additions & 2 deletions man/psm4_exdata.Rd

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

Loading