samonCombine: Combines results from separate runs of the samon function

View source: R/samonCombine.R

samonCombineR Documentation

Combines results from separate runs of the samon function

Description

Combines lists returned from the samon function to form a single object.

Usage

samonCombine( filenames, replaceSampleNo=TRUE, ForceAppend =
FALSE, objlist = NULL )

Arguments

filenames

a vector of rds filenames each containing the output from samon

replaceSampleNo

A logical value determining if the sample numbers should be replaced in the output object. Usually the sample numbers are 1,2,...,NSamples in each file. When the results in filenames are from different runs of samon with different seeds, the results in the output are given unique sample numbers, usually 1, 2, ... NTot, where NTot is the total number of samples.

ForceAppend

put results together even if the files don't match on some criteria, such as the start values for sigma H or sigma F. Otherwise report the problem and return.

objlist

an alternative input of samon objects to be combined.

Details

When the samon function is used in parallel a number of results are returned. If these results are stored in rds files, the samonCombine function can extract the results and combine them to produce a single object.

This is usually done for a single treatment arm at a time.

Value

Returns a list similar to that returned by samon itself. This list may be passed to samonSummary and other samon functions.

Examples

# outputs from samon -- run on samonPANSS1 with different seeds
data("P1Res001")
data("P1Res002")

# combine them
trt1Results <- samonCombine( objlist = list(P1Res001,P1Res002) )

samon documentation built on Oct. 26, 2023, 9:06 a.m.

Related to samonCombine in samon...