-
Notifications
You must be signed in to change notification settings - Fork 0
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
Develop format and rtf functions for exposure duration anaylsis #28
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
# Copyright (c) 2024 Merck & Co., Inc., Rahway, NJ, USA and its affiliates. | ||
# All rights reserved. | ||
# | ||
# This file is part of the metalite.sl program. | ||
# | ||
# metalite.sl is free software: you can redistribute it and/or modify | ||
# it under the terms of the GNU General Public License as published by | ||
# the Free Software Foundation, either version 3 of the License, or | ||
# (at your option) any later version. | ||
# | ||
# This program is distributed in the hope that it will be useful, | ||
# but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
# GNU General Public License for more details. | ||
# | ||
# You should have received a copy of the GNU General Public License | ||
# along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
#' Exposure duration table | ||
#' | ||
#' @param outdata An `outdata` object created by [prepare_sl_summary()]. | ||
#' @param source A character value of the data source. | ||
#' @inheritParams r2rtf::rtf_page | ||
#' @inheritParams r2rtf::rtf_body | ||
#' @param footnotes A character vector of table footnotes. | ||
#' @param title Term "analysis", "observation" and "population") for collecting title from metadata or a character vector of table titles. | ||
#' @param path_outdata A character string of the outdata path. | ||
#' @param path_outtable A character string of the outtable path. | ||
#' | ||
#' @return RTF file and source dataset for baseline characteristic table. | ||
#' | ||
#' @export | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It looks like the functions Looping @wangben718 for a third opinion. |
||
#' | ||
#' @examples | ||
#' meta <- meta_sl_exposure_example() | ||
#' | ||
#' meta |> | ||
#' prepare_exp_duration(population = "apat", parameter = "expdur") |> | ||
#' format_exp_duration() |> | ||
#' rtf_exp_duration( | ||
#' source = "Source: [CDISCpilot: adam-adsl; adex]", | ||
#' path_outdata = tempfile(fileext = ".Rdata"), | ||
#' path_outtable = tempfile(fileext = ".rtf") | ||
#' ) | ||
rtf_exp_duration <- function(outdata, | ||
source = "Source: [CDISCpilot: adam-adsl; adex]", | ||
col_rel_width = NULL, | ||
text_font_size = 9, | ||
orientation = "portrait", | ||
footnotes = c("Each participant is counted once on each applicable duration category row.", | ||
"Duration of Exposure is the time from the first dose date to the last dose date."), | ||
title = NULL, | ||
path_outdata = NULL, | ||
path_outtable = NULL){ | ||
return( | ||
rtf_sl_summary( | ||
outdata, | ||
source, | ||
col_rel_width = col_rel_width, | ||
text_font_size = text_font_size, | ||
orientation = orientation, | ||
footnotes = footnotes, | ||
title = title, | ||
path_outdata = path_outdata, | ||
path_outtable = path_outtable | ||
) | ||
) | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it a good idea if we add a comment explaining what the table
mata |> prepare_sl_summary(...) |> formate_sl_summary(...)
is for? I guess it is a baseline character table. If so, is it equivalent to the one frommata |> prepare_base_char(...) |> formate_base_char(...)
. If so, shall we say something here?