<!doctype s-function-doc system "s-function-doc.dtd" [
<!entity % S-OLD "INCLUDE">
]
>
<s-function-doc>

<s-topics>
<s-topic> summary.RCp </s-topic>
</s-topics>

<s-title>
Summary Method for RCp class objects
</s-title>

<s-description>
When running RCp, we select how many subset selections we wish to make of
each size.  Sometimes after viewing the results it may be desireable to
reduce this number.  This function will reduce the saved RCp file to keep
only the information for the 'best' number of subsets of each size.
</s-description>

<s-usage>
<s-old-style-usage>
summary.RCp(file, best = 5)
</s-old-style-usage>
</s-usage>

<s-args-required>
<s-arg name=" file ">
an RCp object.
</s-arg>
</s-args-required>

<s-args-optional>
<s-arg name=" best ">
an integer, the number of 'best' subsets to be selected for each subset
size.
</s-arg>
</s-args-optional>

<s-value>
a list with class "summary.RCp" similar to the original RCp object.  For
each subset size only the <s-expression>best</s-expression> subsets are
kept.
</s-value>

<s-see>
<s-function name="RCp.sgm">RCp</s-function>.
</s-see>

<s-examples>
<s-example>
</s-example>
</s-examples>

<s-keywords>
<s-keyword>librobust</s-keyword>
</s-keywords>

<s-docclass>
function
</s-docclass>

</s-function-doc>
