Difference between revisions of "Known Issues"
(76 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | [http://www.broadinstitute.org/gsea/ GSEA Home] | | |
− | + | [http://www.broadinstitute.org/gsea/downloads.jsp Downloads] | | |
+ | [http://www.broadinstitute.org/gsea/msigdb/ Molecular Signatures Database] | | ||
+ | [http://www.broadinstitute.org/cancer/software/gsea/wiki/index.php/Main_Page Documentation] | | ||
+ | [http://www.broadinstitute.org/gsea/contact.jsp Contact] | ||
+ | <br> | ||
+ | |||
<h1>GSEA version 2</h1> | <h1>GSEA version 2</h1> | ||
− | <h3>OutOfMemoryError | + | <h3>Java heap space / OutOfMemoryError </h3> |
− | <p><strong>Problem</strong>: When running an analysis in GSEA. the following error occurs: | + | <p><strong>Problem</strong>: When running an analysis in GSEA. the following error occurs:</p> |
− | </p> | + | <p><tt> ---- Stack Trace ----<br /> |
− | <p><tt>---- Stack Trace ----<br /> | ||
# of exceptions: 1<br /> | # of exceptions: 1<br /> | ||
------Java heap space------<br /> | ------Java heap space------<br /> | ||
− | java.lang.OutOfMemoryError: Java heap space </tt></p> | + | java.lang.OutOfMemoryError: Java heap space </tt> </p> |
− | + | <p><strong>Cause</strong>: The error is either due to improper memory allocation, or because you have reached the limits on your machine. </p> | |
− | <p><strong>Cause</strong>: The error is either due to improper memory allocation, or because you have | + | <p><strong>Solutions</strong>: </p> |
− | reached the limits on your machine.</p> | + | <ol> |
− | + | <li>Start GSEA by clicking the <span style="font-variant: small-caps;">Launch</span> button on the [http://www.broadinstitute.org/gsea/downloads.jsp Downloads] page of the GSEA web site and choose the option with larger number for memory allocation. As of Jan 18, 2014, the options are: | |
− | <strong>Solutions</strong>:<ol> | + | <ul><li>1GB (for 32 or 64-bit java)</li> |
− | <li>Start GSEA by clicking the | + | <li>2GB (for 64-bit java only)</li> |
− | + | <li>4GB (for 64-bit java only)</li> | |
− | + | </ul> | |
− | + | </li> | |
− | <li>Run GSEA on a more powerful computer.</li> | + | <li>Run GSEA on a more powerful computer.</li> |
− | <li>Use no more than 1,000 permutations.</li> | + | <li>Use no more than 1,000 permutations.</li> |
− | <li>First, collapse gene identifiers to symbols using | + | <li>Use individual collections or even subcollections of gene sets instead of using all gene sets from the entire MSigDB data base.</li> |
− | [http://www. | + | <li>First, collapse gene identifiers to symbols using [http://www.broadinstitute.org/gsea/doc/GSEAUserGuideTEXT.htm#_Chip2Chip_Page Chip2Chip] tool, then run GSEA on the collapsed data set. <br /> |
− | then run GSEA on the collapsed data set. <br>When running GSEA on the collapsed dataset, make sure that <tt>'Collapse dataset(s)' = false</tt></li> | + | When running GSEA on the collapsed dataset, make sure that <tt>'Collapse dataset(s)' = false</tt></li> |
− | <li> | + | <li>First, create rank ordered list of genes outside GSEA, then run GSEA on the ranked list using [http://www.broadinstitute.org/gsea/doc/GSEAUserGuideTEXT.htm#_GSEAPreranked_Page GSEAPreranked tool] </li> |
− | [http://www. | + | <li>Use the <tt>-Xmx</tt> option to specify sufficient maximum amount of memory for the program by [http://www.broadinstitute.org/gsea/doc/GSEAUserGuideTEXT.htm#_Running_GSEA_from running GSEA from the command line].</li> |
− | |||
</ol> | </ol> | ||
− | <hr width="100%" size="2" / | + | <p> </p> |
+ | <hr width="100%" size="2" hr="" /> | ||
− | <h3> | + | <h3>Firewall / FTP connection issues</h3> |
− | <p><strong>Problem</strong>: When | + | <p><strong>Problem</strong>: When you try to access the <strong>GMT</strong> gene set data files, <strong>CHIP</strong> annotation files or the <strong MSigDB Browser</strong>, you see an error to the effect: </p> |
+ | <p><font color="#ff0000">Error listing Broad website<br>Connection rese</font></p> | ||
+ | <p><strong>Cause</strong>: This usually happens when your computer is behind a firewall or another network configuration that prevents it from accessing FTP servers. The Broad chip files and gene sets are on a public Broad FTP server. The GSEA program tries to connect to the FTP site and use the files but the network configuration blocks the access.</p> | ||
+ | <p><strong>Solutions:</strong><br /> | ||
</p> | </p> | ||
− | < | + | <ol> |
− | + | <li>In the navigation bar at the top of the GSEA program window, go to <strong>Options</strong> and make sure that <strong>Connect over the internet</strong> is checked.</li> | |
− | + | <li> See if you can temporarily disable your firewall when using GSEA.</li> | |
− | + | <li>Consult with your local network administrator to see if they have any suggestions or prior experience with the FTP access issues. </li> | |
− | + | <li>Download the gene set (GMT) and CHIP files to your local file system as follows: | |
− | + | <ol> | |
− | + | <li>Go to the [http://www.broadinstitute.org/gsea/downloads.jsp GSEA Downloads] page</li> | |
− | + | <li>Scroll down the table to <strong>Other resources</strong> and click on <strong>download zip file</strong>. | |
− | + | <p>This file contains all data files for the latest version of MSigDB. To get older, archival releases, scroll up and click the link to download the corresponding zip file. Unzip the file.</p> | |
− | + | <li>Start GSEA. In the navigation bar at the top of the GSEA program window, go to <strong>Options</strong> and turn off the internet connection mode.</li> | |
− | + | <li>Use the Load Data page to load the local CHIP and GMT files.</li> | |
− | + | <li>On the Run GSEA page, select the local annotation files and gene set files rather than using the files from the GSEA website.</li> | |
− | + | </ol> | |
− | + | </li> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | < | ||
</ol> | </ol> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<hr width="100%" size="2" /> | <hr width="100%" size="2" /> | ||
− | <h3>"No probe called" error | + | <h3>"No probe called" error</h3> |
<p><strong>Problem</strong>: When you run GSEA, sometimes the following errors appear in the log file:</p> | <p><strong>Problem</strong>: When you run GSEA, sometimes the following errors appear in the log file:</p> | ||
<p><tt>ERROR - No Probe called: USP9X /// USP9Y on this chip (chip name is >GENE_SYMBOL<)<br /> | <p><tt>ERROR - No Probe called: USP9X /// USP9Y on this chip (chip name is >GENE_SYMBOL<)<br /> | ||
ERROR - Turning off subsequent error notifications</tt></p> | ERROR - Turning off subsequent error notifications</tt></p> | ||
− | <p><strong>Solution</strong>: You can ignore these errors. The three slashes (///) | + | <p><strong>Solution</strong>: You can ignore these errors. The three slashes (<tt>///</tt>) indicate that the chip file contains ambiguous mappings, typical for Affymetrix notation, where a probe set on the chip cannot be mapped to exactly one HUGO gene symbol. GSEA displays this error and ignores such ambigous probes. |
</p> | </p> | ||
+ | <h3>Avoid collapsing ranked list of features to gene symbols</h3> | ||
+ | <p>Collapsing dataset to symbols means that GSEA takes expression dataset and collapses probes to symbols <strong>before</strong> computing the ranking metric values. When done this way, GSEA has two ways to deal with multiple occurrences of expression values corresponding to the same gene symbol. By default, it will retain the maximal expression value; alternatively, it will use median expression value. Both choices make reasonable sense when applied to gene expression values. In the Pre-Ranked mode, however, GSEA is faced with the ranks <strong>already computed</strong> by an unspecified procedure. With the<tt>"Collapse dataset to gene symbols"="true"</tt>, Pre-Ranked GSEA tool will <strong>always</strong> pick the largest positive value among several instances of ranking metric values for the same gene. This can sometimes produce unanticipated results because the original assumptions for gene expression do not necessarily apply to an arbitrary ranking metric in the pre-ranked list, so that the ordered ranked list might substantially differ from the input values. Therefore, collapsing of ranked list is appropriate if and only if all its features are unique and have one to one correspondence to human gene symbols. </p> | ||
+ | <p><strong><font color="red">We thus recommend making the ranked list with human gene symbols as gene identifiers and running GSEAPreranked with the parameter </font><tt>"Collapse dataset to gene symbols"="false"</tt></strong>. </p> | ||
<p> </p> | <p> </p> | ||
− | <h1>GSEA | + | <h3>Browse MSigDB doesn't load custom database XML files</h3> |
− | <h3> | + | <p><strong>Problem</strong>: You have created your own custom database XML file but it does not load into the GSEA browser.<br/> |
− | < | + | |
− | < | + | At this time, this functionality is not yet implemented. The browser can load exclusively msigb_v2.5.xml or msigdb_v3.xml files from our FTP server. Anything else in the path or URL will generate error.</p> |
− | + | ||
− | + | <p><strong>Solution</strong>: To use your own gene sets, please arrange them as GMT or GMX files as described [http://www.broadinstitute.org/cancer/software/gsea/wiki/index.php/Data_formats#Gene_Set_Database_Formats here].</p> | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | < | + | <h1>GSEA-R</h1> |
− | < | + | <h3>Error in memory.size</h3> |
− | < | + | <p><strong>Problem</strong>: When running the example programs provided for R, the following error occurs: </p> |
− | + | <p><tt> [1] " *** Running GSEA Analysis..."<br /> | |
− | < | + | Error in memory.size(size) : don't be silly!: your machine has a 4Gb address limit </tt> </p> |
+ | <p><strong>Cause</strong>: This is produced by the following line early in the GSEA.1.R file:</p> | ||
+ | <p><tt> memory.limit(6000000000)</tt></p> | ||
+ | <p> This line set the memory limit to a large size as a work around to a platform problem with an earlier R version.</p> | ||
+ | <p><strong>Solution</strong>: The easiest fix is just to comment out that line:<br /> | ||
+ | </p> | ||
+ | <p><tt> # memory.limit(6000000000)</tt></p> | ||
+ | <p> This will allocate the default amount of memory. If after this change the program runs out of memory, change the line to:</p> | ||
+ | <p><tt> memory.limit(max. size in Mbytes available)</tt></p> | ||
<hr width="100%" size="2" /> | <hr width="100%" size="2" /> | ||
− | <h3> | + | <h3>16 warnings on R version 2.5 or higher</h3> |
− | < | + | <p><strong>Problem: </strong>When running the example programs provided for R, the following warnings occur:</p> |
− | < | + | <p><tt> 1: '\%' is an unrecognized escape in a character string<br /> |
− | + | 2: unrecognized escape removed from "Tag \%"<br /> | |
− | + | 3: '\%' is an unrecognized escape in a character string<br /> | |
− | + | 4: unrecognized escape removed from "Gene \%"<br /> | |
− | + | 5: '\%' is an unrecognized escape in a character string<br /> | |
− | & | + | 6: unrecognized escape removed from "\%"<br /> |
− | + | 7: '\%' is an unrecognized escape in a character string<br /> | |
− | & | + | 8: unrecognized escape removed from " \%)"<br /> |
− | + | 9: '\.' is an unrecognized escape in a character string<br /> | |
− | + | 10: '\.' is an unrecognized escape in a character string<br /> | |
− | & | + | 11: unrecognized escapes removed from "\.report\."<br /> |
− | + | 12: '\.' is an unrecognized escape in a character string<br /> | |
− | + | 13: '\.' is an unrecognized escape in a character string<br /> | |
− | & | + | 14: unrecognized escapes removed from "\.report\."<br /> |
− | + | 15: '\.' is an unrecognized escape in a character string<br /> | |
− | & | + | 16: unrecognized escape removed from "\." </tt> </p> |
− | < | + | <p><strong>Solution: </strong> These warnings occur when you have R version 2.5 and higher installed. To fix, remove the single backslashes in front of these characters as there is no need to escape them in R versions 2.5 and higher. |
− | < | ||
<hr width="100%" size="2" /> | <hr width="100%" size="2" /> | ||
Latest revision as of 03:50, 25 September 2016
GSEA Home |
Downloads |
Molecular Signatures Database |
Documentation |
Contact
Contents
GSEA version 2
Java heap space / OutOfMemoryError
Problem: When running an analysis in GSEA. the following error occurs:
---- Stack Trace ----
- of exceptions: 1
Java heap space------
java.lang.OutOfMemoryError: Java heap space
Cause: The error is either due to improper memory allocation, or because you have reached the limits on your machine.
Solutions:
- Start GSEA by clicking the Launch button on the Downloads page of the GSEA web site and choose the option with larger number for memory allocation. As of Jan 18, 2014, the options are:
- 1GB (for 32 or 64-bit java)
- 2GB (for 64-bit java only)
- 4GB (for 64-bit java only)
- Run GSEA on a more powerful computer.
- Use no more than 1,000 permutations.
- Use individual collections or even subcollections of gene sets instead of using all gene sets from the entire MSigDB data base.
- First, collapse gene identifiers to symbols using Chip2Chip tool, then run GSEA on the collapsed data set.
When running GSEA on the collapsed dataset, make sure that 'Collapse dataset(s)' = false - First, create rank ordered list of genes outside GSEA, then run GSEA on the ranked list using GSEAPreranked tool
- Use the -Xmx option to specify sufficient maximum amount of memory for the program by running GSEA from the command line.
Firewall / FTP connection issues
Problem: When you try to access the GMT gene set data files, CHIP annotation files or the <strong MSigDB Browser, you see an error to the effect:
Error listing Broad website
Connection rese
Cause: This usually happens when your computer is behind a firewall or another network configuration that prevents it from accessing FTP servers. The Broad chip files and gene sets are on a public Broad FTP server. The GSEA program tries to connect to the FTP site and use the files but the network configuration blocks the access.
Solutions:
- In the navigation bar at the top of the GSEA program window, go to Options and make sure that Connect over the internet is checked.
- See if you can temporarily disable your firewall when using GSEA.
- Consult with your local network administrator to see if they have any suggestions or prior experience with the FTP access issues.
- Download the gene set (GMT) and CHIP files to your local file system as follows:
- Go to the GSEA Downloads page
- Scroll down the table to Other resources and click on download zip file.
This file contains all data files for the latest version of MSigDB. To get older, archival releases, scroll up and click the link to download the corresponding zip file. Unzip the file.
- Start GSEA. In the navigation bar at the top of the GSEA program window, go to Options and turn off the internet connection mode.
- Use the Load Data page to load the local CHIP and GMT files.
- On the Run GSEA page, select the local annotation files and gene set files rather than using the files from the GSEA website.
"No probe called" error
Problem: When you run GSEA, sometimes the following errors appear in the log file:
ERROR - No Probe called: USP9X /// USP9Y on this chip (chip name is >GENE_SYMBOL<)
ERROR - Turning off subsequent error notifications
Solution: You can ignore these errors. The three slashes (///) indicate that the chip file contains ambiguous mappings, typical for Affymetrix notation, where a probe set on the chip cannot be mapped to exactly one HUGO gene symbol. GSEA displays this error and ignores such ambigous probes.
Avoid collapsing ranked list of features to gene symbols
Collapsing dataset to symbols means that GSEA takes expression dataset and collapses probes to symbols before computing the ranking metric values. When done this way, GSEA has two ways to deal with multiple occurrences of expression values corresponding to the same gene symbol. By default, it will retain the maximal expression value; alternatively, it will use median expression value. Both choices make reasonable sense when applied to gene expression values. In the Pre-Ranked mode, however, GSEA is faced with the ranks already computed by an unspecified procedure. With the"Collapse dataset to gene symbols"="true", Pre-Ranked GSEA tool will always pick the largest positive value among several instances of ranking metric values for the same gene. This can sometimes produce unanticipated results because the original assumptions for gene expression do not necessarily apply to an arbitrary ranking metric in the pre-ranked list, so that the ordered ranked list might substantially differ from the input values. Therefore, collapsing of ranked list is appropriate if and only if all its features are unique and have one to one correspondence to human gene symbols.
We thus recommend making the ranked list with human gene symbols as gene identifiers and running GSEAPreranked with the parameter "Collapse dataset to gene symbols"="false".
Browse MSigDB doesn't load custom database XML files
Problem: You have created your own custom database XML file but it does not load into the GSEA browser.
At this time, this functionality is not yet implemented. The browser can load exclusively msigb_v2.5.xml or msigdb_v3.xml files from our FTP server. Anything else in the path or URL will generate error.
Solution: To use your own gene sets, please arrange them as GMT or GMX files as described here.
GSEA-R
Error in memory.size
Problem: When running the example programs provided for R, the following error occurs:
[1] " *** Running GSEA Analysis..."
Error in memory.size(size) : don't be silly!: your machine has a 4Gb address limit
Cause: This is produced by the following line early in the GSEA.1.R file:
memory.limit(6000000000)
This line set the memory limit to a large size as a work around to a platform problem with an earlier R version.
Solution: The easiest fix is just to comment out that line:
# memory.limit(6000000000)
This will allocate the default amount of memory. If after this change the program runs out of memory, change the line to:
memory.limit(max. size in Mbytes available)
16 warnings on R version 2.5 or higher
Problem: When running the example programs provided for R, the following warnings occur:
1: '\%' is an unrecognized escape in a character string
2: unrecognized escape removed from "Tag \%"
3: '\%' is an unrecognized escape in a character string
4: unrecognized escape removed from "Gene \%"
5: '\%' is an unrecognized escape in a character string
6: unrecognized escape removed from "\%"
7: '\%' is an unrecognized escape in a character string
8: unrecognized escape removed from " \%)"
9: '\.' is an unrecognized escape in a character string
10: '\.' is an unrecognized escape in a character string
11: unrecognized escapes removed from "\.report\."
12: '\.' is an unrecognized escape in a character string
13: '\.' is an unrecognized escape in a character string
14: unrecognized escapes removed from "\.report\."
15: '\.' is an unrecognized escape in a character string
16: unrecognized escape removed from "\."
Solution: These warnings occur when you have R version 2.5 and higher installed. To fix, remove the single backslashes in front of these characters as there is no need to escape them in R versions 2.5 and higher.
GSEA on Linux
Browser links do not work under Linux
Problem: When running the GSEA desktop application under Linux, buttons and links that would normally open a browser window do not open the browser window.
Work-around: After running an analysis, you cannot click on the Success link to display the result. However, you can go to the directory that contains the analysis report output and open the index.html file in that directory.