FBNormalization {FBN}R Documentation

FISH Based Normalization and Copy Number Inference of SNP Microarray Data

Description

Normalizes the data from a file containing the raw values of the SNP probes of microarrray data by using the FISH probes and their corresponding CNs.

Usage

FBNormalization(rawDataFileName, fishProbesFileName, 
	normDataFileName, debugFlag, plotFlag, plotAndSaveFlag)
FBNormalization(rawDataFileName = NULL, 
								fishProbesFileName = NULL, 
								normDataFileName = NULL,	
								debugFlag = FALSE, 
								plotFlag = FALSE, 
								plotAndSaveFlag = FALSE)

Arguments

rawDataFileName

The file containig the raw values of the SNP probes. It should be .txt format, tab delimited, containing on each column the SNP probes data of the different samples. The structure of the input file should be as follows:

  • a column containing the identification name of the SNP probes, entitled 'SNP',

  • a column containing the chromosome number of the SNP probes, entitled 'chrom',

  • a column containing the physical positon of the SNP probes, entitled 'physical.position',

  • a column containing the cytoband of the SNP probe, entitled 'cytoband',

  • 'n' columns containing the values of the SNP probes, entitled with the custom identification name of the samples.

fishProbesFileName

The file containing the FISH probes information. It should be .txt format, tab delimited, containing a separate row for each available FISH probe and on each column the various CN data revealed by FISH of the different samples. The structure of the input file should be as follows:

  • each row should represent one FISH probe

  • one column containing the name of the BAC clone, entitled 'BACclone';

  • one column containing the chromosome number where the FISH probe is located, entitled 'chromosome';

  • one column containing the cytoband location of the Fish probe, entitled 'cytoband';

  • one column containing the start position of the physical localization of the FISH probe, entitled 'start.loc';

  • one column containing the end position of the physical localization of the FISH probe, entitled 'end.loc';

  • 'n' columns containing the values of the CN coresponding to the FISH probe, entitled with the custom identification name of the samples.

normDataFileName

The name of the output file where the normalized data will be written. Also, the function writes a file starting with the same name as normDataFileName and ending with '_thresholds.txt', containing the thresholds values that can be used to infer CNs to the normalized data.

debugFlag

Logical value, specifying wether the function should run in debug mode. If TRUE, it plots the various histograms and the detected centers of the clusters in the different samples.

plotFlag

Logical value, specifying wether the function should plot the histograms of the individual data. If TRUE, it plots the various histograms and the detected centers of the clusters in the different samples.

plotAndSaveFlag

Logical value, specifying wether the function should plot and save the various plots of the histograms.

Details

For further detalis, see Supporting Information in Agnelli L et al. (2009), "A SNP Microarray and FISH-Based Procedure to Detect Allelic Imbalances in Multiple Myeloma: an Integrated Genomics Approach Reveals a Wide Gene Dosage Effect", Genes Chrom Cancer

Value

No value is returned. The function writes on the disk the output files as previously described.

Author(s)

Adrian Andronache adi.andronache@gmail.com
Luca Agnelli luca.agnelli@gmail.com

Examples


## set path to FBN package data directory
rawDataFileName = './../data/hmcls.txt'
fishProbesFileName = './../data/FISHprobes.txt'
normDataFileName= 'hmcls_NORM.txt'
FBNormalization(rawDataFileName, fishProbesFileName, normDataFileName, 
	debugFlag = FALSE)

[Package FBN version 1.5.2 Index]