source: plugins/base1/se.lu.onk.cgh_dataDumper/trunk/cgh_dataDumper.base @ 721

Last change on this file since 721 was 721, checked in by Jari Häkkinen, 14 years ago

Shuffling directory structure to the recommended trunk and tags.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 5.8 KB
Line 
1BASEfile
2section plugin
3uniqueName  onk.lu.se/johans/cghDataDumper/
4versionNumber 1.0
5name  Export: CGH Data Dumper
6descr Export: CGH Data Dumper\r\n\r\nThis plugin exports typical BAC data in a simple format readily accessible for e.g. Excel, CGHExplorer, MeV CGH viewer. This plugin works on a normal base file (matrix mode). Therefore, you might want to join array designs using Virtual array if having different designs before running this plugin.\r\n\r\nExported fields are:\r\nReporterId = BAC clone Id\r\nGeneSymbol = Gene symbols of genes mapped to the BAC clone. Could be bundled using ;\r\nChromosome\r\nCytoBand\r\nStartPosition = Start position in BP for the BAC clone\r\nEndPosition = End position in BP for the BAC clone\r\nM = Log2(ratio)\r\n\r\nObserve, that the CGH formats do require probes to be exported to have a genomic mapping.\r\n\r\nStandard Format:\r\nFormat of header line is the above common columns and then the assays with assay names in the header.\r\n\r\nLite Format:\r\nFormat of header line is reporterId,chromosome,start,stop and then the assays with assay names in the header. NOTE: This format should be compatible with MeV CGH viewer.\r\n\r\nSample Name export:\r\nOnly the sample names are exported into a file. No spot data.\r\n\r\nSample Name and annotation export:\r\nThe sample name and a chosen annotation is exported into a file. No spot data.\r\n\r\nAnnotation statistics:\r\nBy specifying in the appropiate text field below in the format e.g. |ER status|brca_family_status|..| you can get a summary of how many assays has a certain annotation value for each of the specified annotation types\r\n\r\nBED format:\r\nThis creates a format similar to BED format as defined by UCSC and Ensembl. Contains four columns, chr,start,stop,reporterId\r\nYou can use bed files to create your own tracks in e.g. UCSC genome browser.\r\n\r\nSingle file Lite. This creates N number of files corresponding to N number of assays. The file name speciefed as a parameter will be the suffix to the assay name. E.g specifying myfile.txt will create a file for Ca13928 as Ca13928_myfile.txt . The format of the individual files are the Lite format (reporterId, chromosome, start, stop, M).\r\n\r\nComplete annotations to file:\r\nThe annotations for all assays are printed to a file. Blanks are filled with NA\r\n\r\nSelected annotations to file:\r\nOnly selected annotations and their assays are printed to file. Blanks are filled with NA.\r\n\r\nMev + annotations\r\nAn MeV compatible file are printed, together with annotations. [TO BE COMPLETED]\r\n\r\nAnnotation Display dump for selected annotations:\r\nFor annotation display option. Enter selected annotations in the format:\r\n|ER Status|p_brca_family_status|etc..|\r\nThese annotations will be separated and a matrix created with N rows = N samples and for each annotation value type, a column will be made with N rows, where each row entry is 1 (annotation value exists for this assay) or 0, no annotation value.\r\n\r\nParameters:\r\n1. [Optional] Give a valid full file name for the created file.\r\n2. [Optional] Sort the data as well. OBS\! Using the sort option may require you to increase the RAM usage considerably if working with large data sets.\r\n3. Select export mode. Either standard or standard_lite as described above, or format suitable for Agilent CGH-analytics software.\r\n4. Select annotation for sample name and annotation export\r\n5. Define annotation types for annotation statistics in the form |ERstatus|brca_family_status|...|\r\n\r\nEnjoy\!  \r\n
7execName  onk.lu.se/johans/cghDataDumper/cgh_dataDumper.pl
8geneAverages  0
9serialFormat  0
10url
11minChannels 2
12maxChannels 0
13leaveStdin  0
14leaveStdout 0
15estimatedTime 3600
16defaultMaxRam 134217728
17usedColumns reporterId\tgeneSymbol\tchromosome\tcytoBand\tstartPosition\tendPosition
18usedFields  l2ratio1_2
19columns position  valueType name  commonName  options defaultValue  enumOptions removed
20%
211 h section   30  cghDataDumperParams   0
2213  t filename  [Optional]  Give the export file a specific filename  50  NULL    0
2314  e sort  Sort the data as well?  30  TRUE  TRUE\tYes\tFALSE\tNo  0
2416  e exportMode  Select export mode  30  standard_lite standard\tStandard format\tagilent\tAgilent CGH-analytics format \tstandard_lite\tStandard Lite\tsampleName\tSample names alone\tsampleName_annotation\tSample names + selected annotation\tannotationStatistics\tAnnotation statistics\tbed\tBED format\tsingleLite\tSingle assay Lite format\tannotationAll\tComplete annotations to file\tannotationSelected\tSelected annotations to file\tMeVannotationAll\tMeV all annotations\tannotationDisplaySelected\tAnnotation display export selected annotations 0
2520  n annotationType  Select annotation for sample name - annotation export 30  0   0
2621  t annoForStat Define the annotation types to get statistics for as |..|..|  30  NULL    0
2722  t yscale  Define y-scale in log 2 ratio 30  NULL    1
2823  i min.clones  Define a minimum number of clones required for each chromosome  30  20    1
2924  e boxes Select degree of  "prettines" on plot 30  pretty  standard\tStandard\tpretty\tPretty \tsimple\tSimple 1
3025  t noiselines  Define if desired 2 "noise lines" in log2(ratio) that will be plotted as dashed 30  NULL    1
3126  t highlight Highlight the following clones  100 NULL    1
3227  e lines Select if to have lines, dots, or both connecting clones  30  p p\tClones as dots\tb\tClones as dots + lines between clones\tl\tOnly lines between dots 1
3328  t assayNameStruct Assay name structure (DO NOT USE %) 30  &1_&2   1
3429  t assayGroup  Assay grouping item 30  NULL    1
3530  e plotStyle Select co-plotting style  30  0 0\tSide by side horizontal\t1\tOn top of each other horizontal  1
3631  t stringDivider Please enter the string divider if coplotting 5 _   1
3733  t highlightGene Highlight the following GENES 30  NULL    1
3834  e VisualizeSegDup Visualize segmental duplications  30  FALSE TRUE\tYes\tFALSE\tNo  1
3935  f qcSegDup  If visualize segDup, enter crosshyb cut off 30  1   1
40
Note: See TracBrowser for help on using the repository browser.