Man pages updated

rpact-com · Mar 26, 2024 · f09af59 · f09af59
1 parent 65f7727
commit f09af59
Show file tree

Hide file tree

Showing 14 changed files with 57 additions and 77 deletions.
diff --git a/README.md b/README.md
@@ -17,22 +17,23 @@ Confirmatory Adaptive Clinical Trial Design, Simulation, and Analysis.
 
 ## Functional Range
 
-- Fixed sample design and designs with interim analysis stages
-- Sample size and power calculation for
-  - means (continuous endpoint)
-  - rates (binary endpoint)
-  - survival trials with flexible recruitment and survival time options
-  - count data
-- Simulation tool for means, rates, and survival data
-  - Assessment of adaptive sample size/event number recalculations based
-    on conditional power
-  - Assessment of treatment selection strategies in multi-arm trials
-- Adaptive analysis of means, rates, and survival data
-- Adaptive designs and analysis for multi-arm trials
-- Adaptive analysis and simulation tools for enrichment design testing
-  means, rates, and hazard ratios
-- Automatic boundary recalculations during the trial for analysis with
-  alpha spending approach, including under- and over-running
+-   Fixed sample design and designs with interim analysis stages
+-   Sample size and power calculation for
+    -   means (continuous endpoint)
+    -   rates (binary endpoint)
+    -   survival trials with flexible recruitment and survival time
+        options
+    -   count data
+-   Simulation tool for means, rates, and survival data
+    -   Assessment of adaptive sample size/event number recalculations
+        based on conditional power
+    -   Assessment of treatment selection strategies in multi-arm trials
+-   Adaptive analysis of means, rates, and survival data
+-   Adaptive designs and analysis for multi-arm trials
+-   Adaptive analysis and simulation tools for enrichment design testing
+    means, rates, and hazard ratios
+-   Automatic boundary recalculations during the trial for analysis with
+    alpha spending approach, including under- and over-running
 
 ## Installation
 
@@ -85,27 +86,27 @@ with `testPackage()`.
 
 # About
 
-- **rpact** is a comprehensive validated[^1] R package for clinical
-  research which
-  - enables the design and analysis of confirmatory adaptive group
-    sequential designs
-  - is a powerful sample size calculator
-  - is a free of charge open-source software licensed under
-    [LGPL-3](https://cran.r-project.org/web/licenses/LGPL-3)
-  - particularly, implements the methods described in the recent
-    monograph by [Wassmer and Brannath
-    (2016)](https://doi.org/10.1007%2F978-3-319-32562-0)
+-   **rpact** is a comprehensive validated[^1] R package for clinical
+    research which
+    -   enables the design and analysis of confirmatory adaptive group
+        sequential designs
+    -   is a powerful sample size calculator
+    -   is a free of charge open-source software licensed under
+        [LGPL-3](https://cran.r-project.org/web/licenses/LGPL-3)
+    -   particularly, implements the methods described in the recent
+        monograph by [Wassmer and Brannath
+        (2016)](https://doi.org/10.1007%2F978-3-319-32562-0)
 
 > For more information please visit
 > [www.rpact.org](https://www.rpact.org)
 
-- **RPACT** is a company which offers
-  - enterprise R/Shiny software development services
-  - technical support for the
-    [rpact](https://cran.r-project.org/package=rpact) package
-  - consultancy and user training for scientists using R
-  - validated software solutions and R package development for clinical
-    research
+-   **RPACT** is a company which offers
+    -   enterprise R/Shiny software development services
+    -   technical support for the
+        [rpact](https://cran.r-project.org/package=rpact) package
+    -   consultancy and user training for scientists using R
+    -   validated software solutions and R package development for
+        clinical research
 
 > For more information please visit
 > [www.rpact.com](https://www.rpact.com)

diff --git a/inst/doc/rpact_getting_started.html b/inst/doc/rpact_getting_started.html
@@ -12,7 +12,7 @@
 
 <meta name="author" content="Friedrich Pahlke and Gernot Wassmer" />
 
-<meta name="date" content="2024-03-25" />
+<meta name="date" content="2024-03-26" />
 
 <title>Getting started with rpact</title>
 
@@ -239,7 +239,7 @@
 
 <h1 class="title toc-ignore">Getting started with rpact</h1>
 <h4 class="author">Friedrich Pahlke and Gernot Wassmer</h4>
-<h4 class="date">2024-03-25</h4>
+<h4 class="date">2024-03-26</h4>
 
 
 

diff --git a/man/getSimulationCounts.Rd b/man/getSimulationCounts.Rd
diff --git a/man/getSimulationEnrichmentMeans.Rd b/man/getSimulationEnrichmentMeans.Rd
diff --git a/man/getSimulationEnrichmentRates.Rd b/man/getSimulationEnrichmentRates.Rd
diff --git a/man/getSimulationMeans.Rd b/man/getSimulationMeans.Rd
diff --git a/man/getSimulationMultiArmMeans.Rd b/man/getSimulationMultiArmMeans.Rd
diff --git a/man/getSimulationMultiArmRates.Rd b/man/getSimulationMultiArmRates.Rd
diff --git a/man/getSimulationRates.Rd b/man/getSimulationRates.Rd
diff --git a/man/param_maxNumberOfSubjectsPerStage.Rd b/man/param_maxNumberOfSubjectsPerStage.Rd
diff --git a/man/param_minNumberOfSubjectsPerStage.Rd b/man/param_minNumberOfSubjectsPerStage.Rd
diff --git a/man/param_plannedCalendarTime.Rd b/man/param_plannedCalendarTime.Rd
diff --git a/man/param_plannedMaxSubjects.Rd b/man/param_plannedMaxSubjects.Rd
diff --git a/man/param_plannedMaxSubjectsPerStage.Rd b/man/param_plannedMaxSubjectsPerStage.Rd