Merge pull request #511 from jdblischak/add-back-sop-specs

Add back recently deleted SOP specs

Author: LittleBeannie

R/gs_design_ahr.R

@@ -74,6 +74,36 @@
 #'   - The `$fail_rate` is a table showing the failure and dropout rates, which is the same as input.
 #'   - The `$bound` is a table summarizing the efficacy and futility bound per analysis.
 #'   - The `analysis` is a table summarizing the analysis time, sample size, events, average HR, treatment effect and statistical information per analysis.
+#'
+#' @section Specification:
+#' \if{latex}{
+#'  \itemize{
+#'    \item Validate if input analysis_time is a positive number or positive
+#'    increasing sequence.
+#'    \item Validate if input info_frac is a positive number or positive
+#'    increasing sequence
+#'    on (0, 1] with final value of 1.
+#'    \item Validate if input info_frac and analysis_time  have the same
+#'    length if both have length > 1.
+#'    \item Get information at input analysis_time
+#'    \itemize{
+#'      \item Use \code{gs_info_ahr()} to get the information and effect size
+#'      based on AHR approximation.
+#'      \item Extract the final event.
+#'      \item Check if input If needed for (any) interim analysis timing.
+#'    }
+#'    \item Add the analysis column to the information at input analysis_time.
+#'    \item Add the sample size column to the information at input analysis_time
+#'    using \code{expected_accural()}.
+#'    \item Get sample size and bounds using \code{gs_design_npe()} and
+#'    save them to bounds.
+#'    \item Add Time, Events, AHR, N that have already been calculated
+#'    to the bounds.
+#'    \item Return a list of design enrollment, failure rates, and bounds.
+#'   }
+#' }
+#' \if{html}{The contents of this section are shown in PDF user manual only.}
+#'
 #' @export
 #'
 #' @details

R/gs_power_ahr.R

@@ -54,6 +54,18 @@
 #'  - If both `event[i]` and `analysis[i]` are provided for analysis `i`, then the time corresponding to the
 #'  later of these is used  for analysis `i`.
 #'
+#' @section Specification:
+#' \if{latex}{
+#'  \itemize{
+#'    \item Calculate information and effect size based on AHR approximation
+#'    using \code{gs_info_ahr()}.
+#'    \item Return a tibble of with columns Analysis, Bound, Z, Probability,
+#'    theta, Time, AHR, Events and  contains a row for each analysis
+#'    and each bound.
+#'   }
+#' }
+#' \if{html}{The contents of this section are shown in PDF user manual only.}
+#'
 #' @export
 #'
 #' @examples