void CHPMultiDataDataTest::test_AlgVersion()
{
CHPMultiDataData data;
data.SetAlgVersion(L"1.0");
CPPUNIT_ASSERT(data.GetAlgVersion() == L"1.0");
}
/*! Create a "multi-data" CHP file with just the header information. The remainder of the file
* will be created at a later time using the buffer writer technique.
* The CHP file will contain only "genotyping" results.
* @param execId The execution identifier. This identifier is used to identify the batch run that created the CHP files.
* @param celFile The full path to the parent CEL file. The header of the CEL file is copied to the CHP file.
* @param outFile The name of the output CHP file.
* @param extraColNames The names of the extra data columns. Should not include probe set name, call and confidence columns.
* @param extraColTypes The types (float, int, ubyte) of the extra columns.
* @param numEntries The number of rows (entries) of results to store in the CHP file.
* @param maxProbeSetNameLength The maximum length of the probe set names.
* @param algName The name of the algorithm used to create the results.
* @param algVersion The algorithm version.
* @param chipType the chip type, also known as the probe array type.
* @param programName The name of the program used to create the CHP file.
* @param programVersion The version of the program.
* @param programCompany The company or institution who developed the CHP creating software.
* @param paramNames A list of parameter names to store in the CHP file header.
* @param paramValues A list of parameter values to store in the CHP file header.
* @param sumNames A list of summary statistic names to store in the CHP file header.
* @param sumValues A list of summary statistic values to store in the CHP file header.
*/
static void CreateFileWithHeader
(
const string &execId,
const string &celFile,
const string &outFile,
const vector<string>& extraColNames,
const vector<string>& extraColTypes,
unsigned long numEntries,
int maxProbeSetNameLength,
const string &algName,
const string &algVersion,
const string &chipType,
const string &programName,
const string &programVersion,
const string &programCompany,
const vector<string>& paramNames,
const vector<string>& paramValues,
const vector<string>& sumNames,
const vector<string>& sumValues,
const vector<string>& extraNames,
const vector<string>& extraValues
)
{
// Create the vector of extra columns. The sample code here supports only float, 32 bit integers and 8 bit unsigned integers.
vector<ColumnInfo> extraColumns;
int ncols = (int)extraColNames.size();
for (int icol=0; icol<ncols; icol++)
{
if (extraColTypes[icol] == "float")
{
FloatColumn fcol(StringUtils::ConvertMBSToWCS(extraColNames[icol]));
extraColumns.push_back(fcol);
}
else if (extraColTypes[icol] == "int")
{
IntColumn intcol(StringUtils::ConvertMBSToWCS(extraColNames[icol]));
extraColumns.push_back(intcol);
}
else if (extraColTypes[icol] == "ubyte")
{
UByteColumn ubcol(StringUtils::ConvertMBSToWCS(extraColNames[icol]));
extraColumns.push_back(ubcol);
}
else
{
throw string("Unsupported column type: ") + extraColTypes[icol];
}
}
// Create the data object
CHPMultiDataData *data = new CHPMultiDataData(outFile);
data->SetEntryCount(GenotypeMultiDataType, numEntries, maxProbeSetNameLength, extraColumns);
data->SetAlgName(StringUtils::ConvertMBSToWCS(algName));
data->SetAlgVersion(StringUtils::ConvertMBSToWCS(algVersion));
data->SetArrayType(StringUtils::ConvertMBSToWCS(chipType));
// Store the CEL header
if (celFile.length() > 0 && FileUtils::Exists(celFile.c_str()) == true)
{
FusionCELData cel;
cel.SetFileName(celFile.c_str());
cel.ReadHeader();
GenericData *gdata = cel.GetGenericData();
if (gdata != NULL)
data->GetFileHeader()->GetGenericDataHdr()->AddParent(*gdata->Header().GetGenericDataHdr());
cel.Close();
}
// Add algorithm parameters to list.
ParameterNameValueTypeList params;
ParameterNameValueType param;
if (programName.empty() == false)
{
param.SetName(L"program-name");
param.SetValueText(StringUtils::ConvertMBSToWCS(programName));
data->GetGenericData().Header().GetGenericDataHdr()->AddNameValParam(param);
}
if (programVersion.empty() == false)
{
param.SetName(L"program-version");
param.SetValueText(StringUtils::ConvertMBSToWCS(programVersion));
data->GetGenericData().Header().GetGenericDataHdr()->AddNameValParam(param);
}
if (programCompany.empty() == false)
{
param.SetName(L"program-company");
param.SetValueText(StringUtils::ConvertMBSToWCS(programCompany));
data->GetGenericData().Header().GetGenericDataHdr()->AddNameValParam(param);
}
int nparams = (int) extraNames.size();
for(int iparam=0; iparam<nparams; iparam++)
{
param.SetName(StringUtils::ConvertMBSToWCS(extraNames[iparam]));
param.SetValueAscii(extraValues[iparam]);
data->GetGenericData().Header().GetGenericDataHdr()->AddNameValParam(param);
}
nparams = (int) paramNames.size();
param.SetName(L"exec-guid");
param.SetValueAscii(execId);
params.push_back(param);
for(int iparam=0; iparam<nparams; iparam++)
{
param.SetName(StringUtils::ConvertMBSToWCS(paramNames[iparam]));
param.SetValueAscii(paramValues[iparam]);
params.push_back(param);
}
if (params.empty() == false)
data->AddAlgParams(params);
params.clear();
nparams = (int) sumNames.size();
for(int iparam=0; iparam<nparams; iparam++)
{
param.SetName(StringUtils::ConvertMBSToWCS(sumNames[iparam]));
param.SetValueAscii(sumValues[iparam]);
params.push_back(param);
}
if (params.empty() == false)
data->AddSummaryParams(params);
// Creating the writer object will create the file with the header information.
CHPMultiDataFileWriter writer(*data);
}
/*
* Create a results file with the CEL file header and other parameters.
*/
void CopyNumberResultWriter::CreateResultFile(affymetrix_fusion_io::FusionCELData& cel, const std::string& fileName)
{
try
{
// Create the results file with the header.
CHPMultiDataData *data = new CHPMultiDataData(fileName);
data->SetEntryCount(CopyNumberMultiDataType, numberProbeSets, maxProbeSetNameLength[CopyNumberMultiDataType], columns);
if (numberCytoRegions > 0)
data->SetEntryCount(CytoMultiDataType, numberCytoRegions, maxProbeSetNameLength[CytoMultiDataType],cytoRegionColumns);
if (numberGenotypeProbeSets > 0)
data->SetEntryCount(GenotypeMultiDataType, numberGenotypeProbeSets, maxProbeSetNameLength[GenotypeMultiDataType], genotypeColumns);
data->SetAlgName(StringUtils::ConvertMBSToWCS(algName));
data->SetAlgVersion(StringUtils::ConvertMBSToWCS(algVersion));
data->SetArrayType(cel.GetChipType());
GenericDataHeader *gdh = data->GetFileHeader()->GetGenericDataHdr();
ParameterNameValueType param;
param.SetName(PROGRAM_NAME);
param.SetValueText(StringUtils::ConvertMBSToWCS(programName));
gdh->AddNameValParam(param);
param.SetName(L"program-version");
param.SetValueText(StringUtils::ConvertMBSToWCS(programVersion));
gdh->AddNameValParam(param);
param.SetName(PROGRAM_COMPANY);
param.SetValueText(StringUtils::ConvertMBSToWCS(programCompany));
gdh->AddNameValParam(param);
ParameterNameValueTypeList params = algParams;
param.SetName(L"ArraySet");
param.SetValueText(cel.GetChipType());
params.push_back(param);
data->AddAlgParams(params);
data->AddSummaryParams(summaryParams);
DataSetHeader *dsh = data->GetDataSetHeader(CopyNumberMultiDataType);
for (ParameterNameValueTypeList::iterator it=chrStartStop.begin(); it!=chrStartStop.end(); it++)
dsh->AddNameValParam(*it);
GenericData *gdata = cel.GetGenericData();
if (gdata != NULL)
gdh->AddParent(*gdata->Header().GetGenericDataHdr());
CHPMultiDataFileWriter *writer = new CHPMultiDataFileWriter(*data);
delete writer;
delete data;
// Create a buffer writer object
outputFiles.clear();
outputFiles.push_back(fileName);
vector<MultiDataType> dataTypes;
dataTypes.push_back(CopyNumberMultiDataType);
if (numberCytoRegions > 0)
dataTypes.push_back(CytoMultiDataType);
if (numberGenotypeProbeSets > 0)
dataTypes.push_back(GenotypeMultiDataType);
bufferWriter = new CHPMultiDataFileBufferWriter();
bufferWriter->Initialize(&outputFiles, dataTypes, maxProbeSetNameLength);
}
catch (CalvinException &ex)
{
string err = "Error creating the output file: " + fileName;
wstring msg = ex.ToString();
if (msg.empty() == false)
err += " " + StringUtils::ConvertWCSToMBS(msg);
throw err;
}
catch (...)
{
string err = "Error creating the output file: " + fileName;
throw err;
}
}