PageSourceSearch

https://docs.rpact.org/reference/

html rpact.org collected 2026-09-26 00:38:38 UTC 19,692 bytes, 674 lines download raw bytes

1<!DOCTYPE html>
2<!-- Generated by pkgdown: do not edit by hand --><html lang="en-US"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Package index • rpact</title>
2<script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script>
2<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.8/bootstrap.min.css" rel="stylesheet">
2<script src="../deps/bootstrap-5.3.8/bootstrap.bundle.min.js"></script>
2<link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet">
2<script src="../deps/headroom-0.11.0/headroom.min.js"></script>
2<script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script>
2<script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script>
2<script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script>
2<script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script>
2<script src="../deps/search-1.0.0/fuse.min.js"></script>
2<script src="../deps/search-1.0.0/mark.min.js"></script>
2<!-- pkgdown -->
2<script src="../pkgdown.js"></script>
2<meta property="og:title" content="Package index"><meta property="og:image" content="https://docs.rpact.org/logo.png"><meta name="keywords" content="rpact, adaptive designs, clinical trials, simulation, analysis, rstats, Shiny, r-project, R package"><link href="reference/figures/favicon.ico" rel="icon"><link href="reference/figures/favicon.ico" rel="apple-touch-icon"><link href="reference/figures/favicon.ico" rel="shortcut icon" type="image/vnd.microsoft.icon"></head><body>
3    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>
4
5
6    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">
7
8    <a class="navbar-brand me-2" href="../index.html">rpact</a>
9
10    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">4.5.0.9321</small>
11
12
13    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
14      <span class="navbar-toggler-icon"></span>
15    </button>
16
17    <div id="navbar" class="collapse navbar-collapse ms-3">
18      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
19<li class="nav-item dropdown">
20  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
21  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/rpact_getting_started.html">Getting started with rpact</a></li>
22  </ul></li>
23<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
24      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
25 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
26<li class="nav-item"><a class="external-link nav-link" href="https://github.com/rpact-com/rpact/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
27      </ul></div>
28
29
30  </div>
31</nav><div class="container template-reference-index">
32<div class="row">
33  <main id="main" class="col-md-9"><div class="page-header">
34      <img src="../logo.png" class="logo" alt=""><h1>Package index</h1>
35    </div>
36
37    <div class="section level2">
38      <h2 id="all-functions">All functions<a class="anchor" aria-label="anchor" href="#all-functions"></a></h2>
39
40
41
42      <dl></dl></div><div class="section level2">
43
44
45
46
47      <dl><dt>
48
49          <code><a href="as251Normal.html">as251Normal()</a></code>
50
51        </dt>
52        <dd>
52Algorithm AS 251: Normal Distribution</dd>
53
54        <dt>
55
56          <code><a href="as251StudentT.html">as251StudentT()</a></code>
57
58        </dt>
59        <dd>Algorithm AS 251: Student T Distribution</dd>
60
61        <dt>
62
63          <code><a href="fetch.ParameterSet.html">obtain()</a></code> <code><a href="fetch.ParameterSet.html">fetch()</a></code>
64
65        </dt>
66        <dd>Extract a single parameter</dd>
67
68        <dt>
69
70          <code><a href="getAccrualTime.html">getAccrualTime()</a></code>
71
72        </dt>
73        <dd>Get Accrual Time</dd>
74
75        <dt>
76
77          <code><a href="getAnalysisResults.html">getAnalysisResults()</a></code>
78
79        </dt>
80        <dd>Get Analysis Results</dd>
81
82        <dt>
83
84          <code><a href="getAvailablePlotTypes.html">plotTypes()</a></code> <code><a href="getAvailablePlotTypes.html">getAvailablePlotTypes()</a></code>
85
86        </dt>
87        <dd>Get Available Plot Types</dd>
88
89        <dt>
90
91          <code><a href="getClosedCombinationTestResults.html">getClosedCombinationTestResults()</a></code>
92
93        </dt>
94        <dd>Get Closed Combination Test Results</dd>
95
96        <dt>
97
98          <code><a href="getClosedConditionalDunnettTestResults.html">getClosedConditionalDunnettTestResults()</a></code>
99
100        </dt>
101        <dd>Get Closed Conditional Dunnett Test Results</dd>
102
103        <dt>
104
105          <code><a href="getConditionalError.html">getConditionalError()</a></code>
106
107        </dt>
108        <dd>Calculate the Optimal Conditional Error</dd>
109
110        <dt>
111
112          <code><a href="getConditionalPower.html">getConditionalPower()</a></code>
113
114        </dt>
115        <dd>Get Conditional Power</dd>
116
117        <dt>
118
119          <code><a href="getConditionalRejectionProbabilities.html">getConditionalRejectionProbabilities()</a></code>
120
121        </dt>
122        <dd>Get Conditional Rejection Probabilities</dd>
123
124        <dt>
125
126          <code><a href="getData.html">getData()</a></code> <code><a href="getData.html">getData.SimulationResults()</a></code>
127
128        </dt>
129        <dd>Get Simulation Data</dd>
130
131        <dt>
132
133          <code><a href="getDataset.html">getDataset()</a></code> <code><a href="getDataset.html">getDataSet()</a></code>
134
135        </dt>
136        <dd>Get Dataset</dd>
137
138        <dt>
139
140          <code><a href="getDesignCharacteristics.html">getDesignCharacteristics()</a></code>
141
142        </dt>
143        <dd>Get Design Characteristics</dd>
144
145        <dt>
146
147          <code><a href="getDesignConditionalDunnett.html">getDesignConditionalDunnett()</a></code>
148
149        </dt>
150        <dd>Get Design Conditional Dunnett Test</dd>
151
152        <dt>
153
154          <code><a href="getDesignFisher.html">getDesignFisher()</a></code>
155
156        </dt>
157        <dd>Get Design Fisher</dd>
158
159        <dt>
160
161          <code><a href="getDesignFixed.html">getDesignFixed()</a></code>
162
163        </dt>
164        <dd>Get Fixed Design</dd>
165
166        <dt>
167
168          <code><a href="getDesignGroupSequential.html">getDesignGroupSequential()</a></code>
169
170        </dt>
171        <dd>Get Design Group Sequential</dd>
172
173        <dt>
174
175          <code><a href="getDesignInverseNormal.html">getDesignInverseNormal()</a></code>
176
177        </dt>
178        <dd>
178Get Design Inverse Normal</dd>
179
180        <dt>
181
182          <code><a href="getDesignOptimalConditionalError.html">getDesignOptimalConditionalError()</a></code>
183
184        </dt>
185        <dd>Create an Optimal Conditional Error Design</dd>
186
187        <dt>
188
189          <code><a href="getDesignSet.html">getDesignSet()</a></code>
190
191        </dt>
192        <dd>Get Design Set</dd>
193
194        <dt>
195
196          <code><a href="getEventProbabilities.html">getEventProbabilities()</a></code>
197
198        </dt>
199        <dd>Get Event Probabilities</dd>
200
201        <dt>
202
203          <code><a href="getFinalConfidenceInterval.html">getFinalConfidenceInterval()</a></code>
204
205        </dt>
206        <dd>Get Final Confidence Interval</dd>
207
208        <dt>
209
210          <code><a href="getFinalPValue.html">getFinalPValue()</a></code>
211
212        </dt>
213        <dd>Get Final P Value</dd>
214
215        <dt>
216
217          <code><a href="getFisherInformation.html">getFisherInformation()</a></code>
218
219        </dt>
220        <dd>Get Fisher Information From a Design Plan or Simulation Results</dd>
221
222        <dt>
223
224          <code><a href="getFutilityBounds.html">getFutilityBounds()</a></code>
225
226        </dt>
227        <dd>Get Futility Bounds</dd>
228
229        <dt>
230
231          <code><a href="getGroupSequentialProbabilities.html">getGroupSequentialProbabilities()</a></code>
232
233        </dt>
234        <dd>Get Group Sequential Probabilities</dd>
235
236        <dt>
237
238          <code><a href="getNumberOfSubjects.html">getNumberOfSubjects()</a></code>
239
240        </dt>
241        <dd>Get Number Of Subjects</dd>
242
243        <dt>
244
245          <code><a href="getObjectRCode.html">rcmd()</a></code> <code><a href="getObjectRCode.html">getObjectRCode()</a></code>
246
247        </dt>
248        <dd>Get Object R Code</dd>
249
250        <dt>
251
252          <code><a href="getObservedInformationRates.html">getObservedInformationRates()</a></code>
253
254        </dt>
255        <dd>Get Observed Information Rates</dd>
256
257        <dt>
258
259          <code><a href="getOutputFormat.html">getOutputFormat()</a></code>
260
261        </dt>
262        <dd>Get Output Format</dd>
263
264        <dt>
265
266          <code><a href="getPerformanceScore.html">getPerformanceScore()</a></code>
267
268        </dt>
269        <dd>Get Performance Score</dd>
270
271        <dt>
272
273          <code><a href="getPiecewiseSurvivalTime.html">getPiecewiseSurvivalTime()</a></code>
274
275        </dt>
276        <dd>Get Piecewise Survival Time</dd>
277
278        <dt>
279
280          <code><a href="getPowerAndAverageSampleNumber.html">getPowerAndAverageSampleNumber()</a></code>
281
282        </dt>
283        <dd>Get Power And Average Sample Number</dd>
284
285        <dt>
286
287          <code><a href="getPowerCounts.html">getPowerCounts()</a></code>
288
289        </dt>
290        <dd>Get Power Counts</dd>
291
292        <dt>
293
294          <code><a href="getPowerMeans.html">getPowerMeans()</a></code>
295
296        </dt>
297        <dd>Get Power Means</dd>
298
299        <dt>
300
301          <code><a href="getPowerRates.html">getPowerRates()</a></code>
302
303        </dt>
304        <dd>Get Power Rates</dd>
305
306        <dt>
307
308          <code><a href="getPowerSurvival.html">getPowerSurvival()</a></code>
309
310        </dt>
311        <dd>Get Power Survival</dd>
312
313        <dt>
314
315          <code><a href="getRawData.html">getRawData()</a></code>
316
317        </dt>
318        <dd>Get Simulation Raw Data for Survival</dd>
319
320        <dt>
321
322          <code><a href="getRepeatedConfidenceIntervals.html">getRepeatedConfidenceIntervals()</a></code>
323
324        </dt>
325        <dd>Get Repeated Confidence Intervals</dd>
326
327        <dt>
328
329          <code><a href="getRepeatedPValues.html">getRepeatedPValues()</a></code>
330
331        </dt>
332        <dd>Get Repeated P Values</dd>
333
334        <dt>
335
336          <code><a href="getSampleSizeCounts.html">getSampleSizeCounts()</a></code>
337
338        </dt>
339        <dd>Get Sample Size Counts</dd>
340
341        <dt>
342
343          <code><a href="getSampleSizeMeans.html">getSampleSizeMeans()</a></code>
344
345        </dt>
346        <dd>Get Sample Size Means</dd>
347
348        <dt>
349
350          <code><a href="getSampleSizeRates.html">getSampleSizeRates()</a></code>
351
352        </dt>
353        <dd>Get Sample Size Rates</dd>
354
355        <dt>
356
357          <code><a href="getSampleSizeSurvival.html">getSampleSizeSurvival()</a></code>
358
359        </dt>
360        <dd>Get Sample Size Survival</dd>
361
362        <dt>
363
364          <code><a href="getSimulationCounts.html">getSimulationCounts()</a></code>
365
366        </dt>
367        <dd>Get Simulation Counts</dd>
368
369        <dt>
370
371          <code><a href="getSimulationEnrichmentMeans.html">getSimulationEnrichmentMeans()</a></code>
372
373        </dt>
374        <dd>Get Simulation Enrichment Means</dd>
375
376        <dt>
377
378          <code><a href="getSimulationEnrichmentRates.html">getSimulationEnrichmentRates()</a></code>
379
380        </dt>
381        <dd>Get Simulation Enrichment Rates</dd>
382
383        <dt>
384
385          <code><a href="getSimulationEnrichmentSurvival.html">getSimulationEnrichmentSurvival()</a></code>
386
387        </dt>
388        <dd>Get Simulation Enrichment Survival</dd>
389
390        <dt>
391
392          <code><a href="getSimulationMeans.html">getSimulationMeans()</a></code>
393
394        </dt>
395        <dd>Get Simulation Means</dd>
396
397        <dt>
398
399          <code><a href="getSimulationMultiArmMeans.html">getSimulationMultiArmMeans()</a></code>
400
401        </dt>
402        <dd>Get Simulation Multi-Arm Means</dd>
403
404        <dt>
405
406          <code><a href="getSimulationMultiArmRates.html">getSimulationMultiArmRates()</a></code>
407
408        </dt>
409        <dd>Get Simulation Multi-Arm Rates</dd>
410
411        <dt>
412
413          <code><a href="getSimulationMultiArmSurvival.html">getSimulationMultiArmSurvival()</a></code>
414
415        </dt>
416        <dd>Get Simulation Multi-Arm Survival</dd>
417
418        <dt>
419
420          <code><a href="getSimulationRates.html">getSimulationRates()</a></code>
421
422        </dt>
423        <dd>Get Simulation Rates</dd>
424
425        <dt>
426
427          <code><a href="getSimulationSurvival.html">getSimulationSurvival()</a></code>
428
429        </dt>
430        <dd>Get Simulation Survival</dd>
431
432        <dt>
433
434          <code><a href="getStageInformation.html">getStageInformation()</a></code>
435
436        </dt>
437        <dd>Calculate Stage Information for an Adaptive Design</dd>
438
439        <dt>
440
441          <code><a href="getStageResults.html">getStageResults()</a></code>
442
443        </dt>
444        <dd>Get Stage Results</dd>
445
446        <dt>
447
448          <code><a href="getTestActions.html">getTestActions()</a></code>
449
450        </dt>
451        <dd>Get Test Actions</dd>
452
453        <dt>
454
455          <code><a href="knit_print.SummaryFactory.html">knit_print(<i>&lt;SummaryFactory&gt;</i>)</a></code>
456
457        </dt>
458        <dd>Print Summary Factory in Markdown Code Chunks</dd>
459
460        <dt>
461
462          <code><a href="mvnprd.html">mvnprd()</a></code>
463
464        </dt>
465        <dd>
465Original Algorithm AS 251: Normal Distribution</dd>
466
467        <dt>
468
469          <code><a href="mvstud.html">mvstud()</a></code>
470
471        </dt>
472        <dd>Original Algorithm AS 251: Student T Distribution</dd>
473
474        <dt>
475
476          <code><a href="plot.AnalysisResults.html">plot(<i>&lt;AnalysisResults&gt;</i>)</a></code>
477
478        </dt>
479        <dd>Analysis Results Plotting</dd>
480
481        <dt>
482
483          <code><a href="plot.Dataset.html">plot(<i>&lt;Dataset&gt;</i>)</a></code>
484
485        </dt>
486        <dd>Dataset Plotting</dd>
487
488        <dt>
489
490          <code><a href="plot.EventProbabilities.html">plot(<i>&lt;EventProbabilities&gt;</i>)</a></code>
491
492        </dt>
493        <dd>Event Probabilities Plotting</dd>
494
495        <dt>
496
497          <code><a href="plot.NumberOfSubjects.html">plot(<i>&lt;NumberOfSubjects&gt;</i>)</a></code>
498
499        </dt>
500        <dd>Number Of Subjects Plotting</dd>
501
502        <dt>
503
504          <code><a href="plot.ParameterSet.html">plot(<i>&lt;ParameterSet&gt;</i>)</a></code>
505
506        </dt>
507        <dd>Parameter Set Plotting</dd>
508
509        <dt>
510
511          <code><a href="plot.SimulationResults.html">plot(<i>&lt;SimulationResults&gt;</i>)</a></code>
512
513        </dt>
514        <dd>Simulation Results Plotting</dd>
515
516        <dt>
517
518          <code><a href="plot.StageResults.html">plot(<i>&lt;StageResults&gt;</i>)</a></code>
519
520        </dt>
521        <dd>Stage Results Plotting</dd>
522
523        <dt>
524
525          <code><a href="plot.SummaryFactory.html">plot(<i>&lt;SummaryFactory&gt;</i>)</a></code>
526
527        </dt>
528        <dd>Summary Factory Plotting</dd>
529
530        <dt>
531
532          <code><a href="plot.TrialDesign.html">plot(<i>&lt;TrialDesign&gt;</i>)</a></code> <code><a href="plot.TrialDesign.html">plot(<i>&lt;TrialDesignCharacteristics&gt;</i>)</a></code>
533
534        </dt>
535        <dd>Trial Design Plotting</dd>
536
537        <dt>
538
539          <code><a href="plot.TrialDesignOptimalConditionalError.html">plot(<i>&lt;TrialDesignOptimalConditionalError&gt;</i>)</a></code>
540
541        </dt>
542        <dd>Plot the optimal conditional error function</dd>
543
544        <dt>
545
546          <code><a href="plot.TrialDesignPlan.html">plot(<i>&lt;TrialDesignPlan&gt;</i>)</a></code>
547
548        </dt>
549        <dd>Trial Design Plan Plotting</dd>
550
551        <dt>
552
553          <code><a href="plot.TrialDesignSet.html">plot(<i>&lt;TrialDesignSet&gt;</i>)</a></code>
554
555        </dt>
556        <dd>Trial Design Set Plotting</dd>
557
558        <dt>
559
560          <code><a href="plot.TrialDesignSummaries.html">plot(<i>&lt;TrialDesignSummaries&gt;</i>)</a></code>
561
562        </dt>
563        <dd>Plot Trial Design Summaries</dd>
564
565        <dt>
566
567          <code><a href="print.SummaryFactory.html">print(<i>&lt;SummaryFactory&gt;</i>)</a></code>
568
569        </dt>
570        <dd>Summary Factory Printing</dd>
571
572        <dt>
573
574          <code><a href="print.TrialDesignCharacteristics.html">print(<i>&lt;TrialDesignCharacteristics&gt;</i>)</a></code>
575
576        </dt>
577        <dd>Trial Design Characteristics Printing</dd>
578
579        <dt>
580
581          <code><a href="print.TrialDesignOptimalConditionalError.html">print(<i>&lt;TrialDesignOptimalConditionalError&gt;</i>)</a></code>
582
583        </dt>
584        <dd>Print optimal conditional error trial design</dd>
585
586        <dt>
587
588          <code><a href="print.TrialDesignSummaries.html">print(<i>&lt;TrialDesignSummaries&gt;</i>)</a></code>
589
590        </dt>
591        <dd>Print Trial Design Summaries</dd>
592
593        <dt>
594
595          <code><a href="readDataset.html">readDataset()</a></code>
596
597        </dt>
598        <dd>Read Dataset</dd>
599
600        <dt>
601
602          <code><a href="readDatasets.html">readDatasets()</a></code>
603
604        </dt>
605        <dd>Read Multiple Datasets</dd>
606
607        <dt>
608
609          <code><a href="rpact.html">rpact-package</a></code> <code><a href="rpact.html">rpact</a></code>
610
611        </dt>
612        <dd>rpact - Confirmatory Adaptive Clinical Trial Design and Analysis</dd>
613
614        <dt>
615
616          <code><a href="setOutputFormat.html">setOutputFormat()</a></code>
617
618        </dt>
619        <dd>Set Output Format</dd>
620
621        <dt>
622
623          <code><a href="summary.TrialDesignOptimalConditionalError.html">summary(<i>&lt;TrialDesignOptimalConditionalError&gt;</i>)</a></code>
624
625        </dt>
626        <dd>Summary of the optimal conditional error trial design</dd>
627
628        <dt>
629
630          <code><a href="testPackage.html">testPackage()</a></code>
631
632        </dt>
633        <dd>Test and Validate the rpact Package Installation</dd>
634
635        <dt>
636
637          <code><a href="utilitiesForPiecewiseExponentialDistribution.html">getPiecewiseExponentialDistribution()</a></code> <code><a href="utilitiesForPiecewiseExponentialDistribution.html">ppwexp()</a></code> <code><a href="utilitiesForPiecewiseExponentialDistribution.html">getPiecewiseExponentialQuantile()</a></code> <code><a href="utilitiesForPiecewiseExponentialDistribution.html">qpwexp()</a></code> <code><a href="utilitiesForPiecewiseExponentialDistribution.html">getPiecewiseExponentialRandomNumbers()</a></code> <code><a href="utilitiesForPiecewiseExponentialDistribution.html">rpwexp()</a></code>
638
639        </dt>
640        <dd>The Piecewise Exponential Distribution</dd>
641
642        <dt>
643
644          <code><a href="writeDataset.html">writeDataset()</a></code>
645
646        </dt>
647        <dd>Write Dataset</dd>
648
649        <dt>
650
651          <code><a href="writeDatasets.html">writeDatasets()</a></code>
652
653        </dt>
654        <dd>Write Multiple Datasets</dd>
655      </dl></div>
656  </main></div>
657
658
659    <footer><div class="pkgdown-footer-left">
660  <p>Developed by Gernot Wassmer, Friedrich Pahlke, RPACT GmbH.</p>
661</div>
662
663<div class="pkgdown-footer-right">
664  <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.2.1.</p>
665</div>
666
667    </footer></div>
668
669
670
671
672
673  </body></html>
674

Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.