Skip to content

Commit

Permalink
fix warnings of missing @param
Browse files Browse the repository at this point in the history
  • Loading branch information
LittleBeannie committed Sep 10, 2024
1 parent c9620d3 commit c61aecd
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
11 changes: 11 additions & 0 deletions R/wlr.R
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,17 @@
#' @param return_variance A logical flag that, if `TRUE`, adds columns
#' estimated variance for weighted sum of observed minus expected;
#' see details; Default: `FALSE`.
#' @param ratio randomization ratio (experimental:control).
#' - If the `data` is generated by simtrial, such as
#' + `data = sim_pw_surv(...) |> cut_data_by_date(...)`
#' + `data = sim_pw_surv(...) |> cut_data_by_event(...)`
#' + `data = sim_pw_surv(...) |> cut_data_by_date(...) |> counting_process(...)`
#' + `data = sim_pw_surv(...) |> cut_data_by_event(...) |> counting_process(...)`
#' there is no need to input the `ratio`, as simtrial gets the `ratio` via the
#' `block` arguments in [sim_pw_surv()].
#' - If the `data` is a custom dataset (see Example 2) below,
#' + Users are suggested to input the planned randomization ratio to `ratio`;
#' + If not, simtrial takes the empirical randomization ratio.
#'
#' @return A list containing the test method (`method`),
#' parameters of this test method (`parameter`),
Expand Down
18 changes: 18 additions & 0 deletions man/wlr.Rd

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

0 comments on commit c61aecd

Please sign in to comment.