optimal_return_doc: Function for generating documentation of return values

View source: R/optimal_return_doc.R

optimal_return_docR Documentation

Function for generating documentation of return values

Description

Generates the documentation of the return value of an optimal function including some custom text.

Usage

optimal_return_doc(type, setting = "basic")

Arguments

type

string deciding whether this is return text for normal, binary or time-to-event endpoints

setting

string containing the setting, i.e. "basic", "bias", "multitrial"

Value

string containing the documentation of the return value.


Sterniii3/drugdevelopR documentation built on Jan. 26, 2024, 6:17 a.m.