# rpact: Confirmatory Adaptive Clinical Trial Design and Analysis ParameterSet_summary {rpact} R Documentation

## Parameter Set Summary

### Description

Displays a summary of `ParameterSet` object.

### Usage

```## S3 method for class 'ParameterSet'
summary(object, ..., type = 1, digits = NA_integer_)
```

### Arguments

 `object` A `ParameterSet` object. `...` Ensures that all arguments (starting from the "...") are to be named and that a warning will be displayed if unknown arguments are passed. `digits` Defines how many digits are to be used for numeric values.

### Details

Summarizes the parameters and results of a parameter set.

### Value

Returns a `SummaryFactory` object. The following generics (R generic functions) are available for this result object:

• `names` to obtain the field names,

• `print` to print the object

### Summary options

The following options can be set globally:

1. `rpact.summary.output.size`: one of `c("small", "medium", "large")`; defines how many details will be included into the summary; default is `"large"`, i.e., all available details are displayed.

2. `rpact.summary.justify`: one of `c("right", "left", "centre")`; shall the values be right-justified (the default), left-justified or centered.

3. `rpact.summary.intervalFormat`: defines how intervals will be displayed in the summary, default is `"[%s; %s]"`.

4. `rpact.summary.digits`: defines how many digits are to be used for numeric values (default is `3`).

5. `rpact.summary.digits.probs`: defines how many digits are to be used for numeric values (default is one more than value of `rpact.summary.digits`, i.e., `4`).

6. `rpact.summary.trim.zeroes`: if `TRUE` (default) zeroes will always displayed as "0", e.g. "0.000" will become "0".

Example: `options("rpact.summary.intervalFormat" = "%s - %s")`

### How to get help for generic functions

Click on the link of a generic in the list above to go directly to the help documentation of the `rpact` specific implementation of the generic. Note that you can use the R function `methods` to get all the methods of a generic and to identify the object specific name of it, e.g., use `methods("plot")` to get all the methods for the `plot` generic. There you can find, e.g., `plot.AnalysisResults` and obtain the specific help documentation linked above by typing `?plot.AnalysisResults`.

[Package rpact version 3.0.0 Index | www.rpact.org]
{"ft_lang_label":"__label__en","ft_lang_prob":0.54027665,"math_prob":0.6976907,"size":1978,"snap":"2020-45-2020-50","text_gpt3_token_len":478,"char_repetition_ratio":0.12867275,"word_repetition_ratio":0.08852459,"special_character_ratio":0.24570273,"punctuation_ratio":0.21641791,"nsfw_num_words":0,"has_unicode_error":false,"math_prob_llama3":0.95883685,"pos_list":[0,1,2],"im_url_duplicate_count":[null,null,null],"WARC_HEADER":"{\"WARC-Type\":\"response\",\"WARC-Date\":\"2020-10-26T16:41:02Z\",\"WARC-Record-ID\":\"<urn:uuid:db1cca65-e878-4393-bf90-07d000bb1688>\",\"Content-Length\":\"4579\",\"Content-Type\":\"application/http; msgtype=response\",\"WARC-Warcinfo-ID\":\"<urn:uuid:183e9712-b143-41dc-b600-c26baf2ffb87>\",\"WARC-Concurrent-To\":\"<urn:uuid:661b4a69-2b43-421b-9cb0-75cf6e803f3b>\",\"WARC-IP-Address\":\"85.13.134.84\",\"WARC-Target-URI\":\"https://manual.rpact.org/html/ParameterSet_summary.html\",\"WARC-Payload-Digest\":\"sha1:ZWGTWFACP4PMSU4FRYN5YXV7R4HT4H4U\",\"WARC-Block-Digest\":\"sha1:LJ6UN56OYT74RMNFK6JHIUR7YE5TVDAR\",\"WARC-Identified-Payload-Type\":\"application/xhtml+xml\",\"warc_filename\":\"/cc_download/warc_2020/CC-MAIN-2020-45/CC-MAIN-2020-45_segments_1603107891428.74_warc_CC-MAIN-20201026145305-20201026175305-00034.warc.gz\"}"}