Skip to content

Commit

Permalink
Updated manifest, docs, etc ahead of the GSEA 4.2.0 release
Browse files Browse the repository at this point in the history
Will be bumping the version to 20.3.x.
  • Loading branch information
davideby committed Nov 3, 2021
1 parent ade2255 commit 60b948c
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 46 deletions.
20 changes: 10 additions & 10 deletions docs/v20/index.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!-- saved from url=(0083)http://software.broadinstitute.org/cancer/software/genepattern/modules/docs/GSEA/18 -->
<html class=""><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GSEA (v20.2.x)</title>
<title>GSEA (v20.3.x)</title>
<link href="./application.css" media="all" rel="stylesheet">
<script src="./application.js"></script><style>.cke{visibility:hidden;}</style><style type="text/css"></style>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
Expand All @@ -15,7 +15,7 @@

<div class="gp-content-header fluid">
<div class="container">
<h1>GSEA (v20.2.x) <a style="float: right" href="https://www.genepattern.org"><img alt="GP Logo" src="gplogo.png" /></a></h1>
<h1>GSEA (v20.3.x) <a style="float: right" href="https://www.genepattern.org"><img alt="GP Logo" src="gplogo.png" /></a></h1>
</div>
</div>
<div class="container">
Expand All @@ -33,7 +33,7 @@ <h1>GSEA (v20.2.x) <a style="float: right" href="https://www.genepattern.org"><i
<p></p>
</div>
<div class="col-sm-4">
<p><strong>GSEA Version: </strong> 4.1.0</p>
<p><strong>GSEA Version: </strong> 4.2.0</p>
</div>
</div>

Expand Down Expand Up @@ -318,10 +318,6 @@ <h2>Parameters</h2>
<td valign="top">create gcts&nbsp;<span style="color:red;">*</span></td>
<td valign="top">Whether to save the dataset subsets backing the GSEA report heatmaps as GCT files; these will be subsets of your original dataset corresponding only to the genes of the heatmap.&nbsp;</td>
</tr>
<tr>
<td valign="top">create zip&nbsp;<span style="color:red;">*</span></td>
<td valign="top">Create a ZIP bundle of the output files. This is true by default, matching the former behavior where a ZIP bundle was always created.</td>
</tr>
</tbody>
</table>

Expand Down Expand Up @@ -358,11 +354,10 @@ <h2>Input Files</h2>

<h2>Output Files</h2>

<p>1. Optional Enrichment Report archive: ZIP</p>
<p>1. Enrichment Report archive: ZIP</p>

<p style="margin-left: 40px;">ZIP file containing the result files. &nbsp;For more information on interpreting these results, see <a href="http://www.gsea-msigdb.org/gsea/doc/GSEAUserGuideTEXT.htm#_Interpreting_GSEA_Results">Interpreting GSEA Results</a> in the GSEA User Guide.
Note that in prior versions the ZIP bundle was created as the only output file. This behavior has been changed to give direct access to the results without the need for a download. The default is to create the ZIP bundle, matching the former behavior, but the report files
will always be created directly.</p>
Note that in prior versions the ZIP bundle was created as the only output file. This behavior has been changed to give direct access to the results without the need for a download.</p>

<p>2. Enrichment Report: HTML and PNG images</p>

Expand Down Expand Up @@ -410,6 +405,11 @@ <h2>Version Comments</h2>
</tr>
</thead>
<tbody>
<tr>
<td>20.3.0</td>
<td>2021-11-5</td>
<td>Updated with the GSEA Desktop 4.2.0 code base with numerous bug fixes. Fixed some issues handling datasets with missing values. Introduced the Spearman metric. Fixed issue with the min-sample check with gene_set permutation mode. Changed the FDR q-value scale on the NES vs Significance plot.</td>
</tr>
<tr>
<td>20.2.4</td>
<td>2021-4-22</td>
Expand Down
19 changes: 9 additions & 10 deletions docs/v20/test.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# GSEA (v20.2.x)
# GSEA (v20.3.x)

Gene Set Enrichment Analysis

Expand All @@ -14,7 +14,7 @@ for GSEA questions.
team](http://software.broadinstitute.org/cancer/software/genepattern/contact)
for GenePattern issues.

**GSEA Version:** 4.1.0
**GSEA Version:** 4.2.0

## Description

Expand Down Expand Up @@ -367,10 +367,6 @@ For descriptions of the ranking metrics, see <a href="http://www.gsea-msigdb.org
<td align="left">create gcts <span style="color:red;">*</span></td>
<td align="left">Whether to save the dataset subsets backing the GSEA report heatmaps as GCT files; these will be subsets of your original dataset corresponding only to the genes of the heatmap. </td>
</tr>
<tr class="even">
<td align="left">create zip <span style="color:red;">*</span></td>
<td align="left">Create a ZIP bundle of the output files. This is true by default, matching the former behavior where a ZIP bundle was always created.</td>
</tr>
</tbody>
</table>

Expand Down Expand Up @@ -423,16 +419,14 @@ drop-down

## Output Files

1\. Optional Enrichment Report archive: ZIP
1\. Enrichment Report archive: ZIP

ZIP file containing the result files.  For more information on
interpreting these results, see [Interpreting GSEA
Results](http://www.gsea-msigdb.org/gsea/doc/GSEAUserGuideTEXT.htm#_Interpreting_GSEA_Results)
in the GSEA User Guide. Note that in prior versions the ZIP bundle was
created as the only output file. This behavior has been changed to give
direct access to the results without the need for a download. The
default is to create the ZIP bundle, matching the former behavior, but
the report files will always be created directly.
direct access to the results without the need for a download.

2\. Enrichment Report: HTML and PNG images

Expand Down Expand Up @@ -476,6 +470,11 @@ Java
</tr>
</thead>
<tbody>
<tr class="even">
<td align="left">20.3.0</td>
<td align="left">2021-11-2</td>
<td align="left">Updated with the GSEA Desktop 4.2.0 code base with numerous bug fixes. Fixed some issues handling datasets with missing values. Introduced the Spearman metric. Fixed issue with the min-sample check with gene_set permutation mode. Changed the FDR q-value scale on the NES vs Significance plot.</td>
</tr>
<tr class="odd">
<td align="left">20.2.4</td>
<td align="left">2021-4-22</td>
Expand Down
33 changes: 10 additions & 23 deletions manifest
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
#Fri, 05 Oct 2018 04:51:00 +0900
# Copyright (c) 2003-2020 Broad Institute, Inc., Massachusetts Institute of Technology, and Regents of the University of California. All rights reserved.
# Copyright (c) 2003-2021 Broad Institute, Inc., Massachusetts Institute of Technology, and Regents of the University of California. All rights reserved.
#GSEA
JVMLevel=11
LSID=urn\:lsid\:broad.mit.edu\:cancer.software.genepattern.module.analysis\:00072\:999999999
author=Aravind Subramanian, Pablo Tamayo, David Eby; Broad Institute
commandLine=/opt/gsea/GSEA_4.1.0/gsea-cli.sh GSEA -res <expression.dataset> -cls <phenotype.labels> -collapse <collapse.dataset> -mode <collapsing.mode.for.probe.sets.with.more.than.one.match> -norm <normalization.mode> -nperm <number.of.permutations> -permute <permutation.type> -rnd_type <randomization.mode> -scoring_scheme <scoring.scheme> -metric <metric.for.ranking.genes> -sort <gene.list.sorting.mode> -order <gene.list.ordering.mode> -include_only_symbols <omit.features.with.no.symbol.match> -make_sets <make.detailed.gene.set.report> -median <median.for.class.metrics> -num <number.of.markers> -plot_top_x <plot.graphs.for.the.top.sets.of.each.phenotype> -rnd_seed <random.seed> -save_rnd_lists <save.random.ranked.lists> -set_max <max.gene.set.size> -set_min <min.gene.set.size> <chip.platform.file> -gmx_list <gene.sets.database> -create_svgs <create.svgs> -create_gcts <create.gcts> -target_profile <target.profile> <selected.gene.sets> <output.file.name> <alt.delim> -dev_mode <dev.mode> -zip_report <create.zip> -run_as_genepattern true
commandLine=/opt/gsea/GSEA_4.2.0/gsea-cli.sh GSEA -res <expression.dataset> -cls <phenotype.labels> -collapse <collapse.dataset> -mode <collapsing.mode.for.probe.sets.with.more.than.one.match> -norm <normalization.mode> -nperm <number.of.permutations> -permute <permutation.type> -rnd_type <randomization.mode> -scoring_scheme <scoring.scheme> -metric <metric.for.ranking.genes> -sort <gene.list.sorting.mode> -order <gene.list.ordering.mode> -include_only_symbols <omit.features.with.no.symbol.match> -make_sets <make.detailed.gene.set.report> -median <median.for.class.metrics> -num <number.of.markers> -plot_top_x <plot.graphs.for.the.top.sets.of.each.phenotype> -rnd_seed <random.seed> -save_rnd_lists <save.random.ranked.lists> -set_max <max.gene.set.size> -set_min <min.gene.set.size> <chip.platform.file> -gmx_list <gene.sets.database> -create_svgs <create.svgs> -create_gcts <create.gcts> -target_profile <target.profile> <selected.gene.sets> <output.file.name> <alt.delim> -dev_mode <dev.mode> -zip_report true -run_as_genepattern true
cpuType=any
taskDoc=doc.html
description=Gene Set Enrichment Analysis. <strong>If you are using GSEA on RNA-seq data, please read <a href="http://software.broadinstitute.org/cancer/software/gsea/wiki/index.php/Using_RNA-seq_Datasets_with_GSEA" target="_blank">these guidelines</a>.</strong>
fileFormat=zip
language=Java
name=GSEA
os=any
job.docker.image=genepattern/gsea_4.1.0\:0.1
job.docker.image=genepattern/gsea_4.2.0\:0.1


p1_MODE=IN
Expand Down Expand Up @@ -359,7 +359,7 @@ p26_value=
p27_MODE=
p27_TYPE=TEXT
p27_default_value=<expression.dataset_basename>.zip
p27_description=Name of the output file. Note that this only applies if create.zip\=true.
p27_description=Name of the output ZIP file.
p27_fileFormat=
p27_flag=
p27_name=output.file.name
Expand All @@ -384,11 +384,11 @@ p28_value=

p29_MODE=
p29_TYPE=TEXT
p29_default_value=true
p29_description=Create a ZIP bundle of the output files.
p29_default_value=false
p29_description=Whether to save the dataset subsets backing the GSEA report heatmaps as GCT files; these will be subsets of your original dataset corresponding only to the genes of the heatmap.
p29_fileFormat=
p29_flag=
p29_name=create.zip
p29_name=create.gcts
p29_optional=
p29_prefix=
p29_prefix_when_specified=
Expand All @@ -398,29 +398,16 @@ p29_value=false;true
p30_MODE=
p30_TYPE=TEXT
p30_default_value=false
p30_description=Whether to save the dataset subsets backing the GSEA report heatmaps as GCT files; these will be subsets of your original dataset corresponding only to the genes of the heatmap.
p30_description=Enable developer mode.
p30_fileFormat=
p30_flag=
p30_name=create.gcts
p30_name=dev.mode
p30_optional=
p30_prefix=
p30_prefix_when_specified=
p30_type=java.lang.String
p30_value=false;true

p31_MODE=
p31_TYPE=TEXT
p31_default_value=false
p31_description=Enable developer mode.
p31_fileFormat=
p31_flag=
p31_name=dev.mode
p31_optional=
p31_prefix=
p31_prefix_when_specified=
p31_type=java.lang.String
p31_value=false;true

pipelineModel=
privacy=public
quality=development
Expand All @@ -430,6 +417,6 @@ serializedModel=
taskType=Pathway Analysis
categories=gsea;pathway analysis
[email protected]
version=Fixed minor typo.
version=Updated with the GSEA Desktop 4.2.0 code base with numerous bug fixes. Fixed some issues handling datasets with missing values. Introduced the Spearman metric. Fixed issue with the min-sample check with gene_set permutation mode. Changed the FDR q-value scale on the NES vs Significance plot.

publicationDate=10/05/2018 04\:51
2 changes: 1 addition & 1 deletion paramgroups.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[{name: "Basic parameters", description: "These parameters are essential for the analysis.", parameters: ["expression.dataset", "gene.sets.database", "number.of.permutations", "phenotype.labels", "target.profile", "permutation.type", "collapse.dataset", "chip.platform.file", "output.file.name" ]},
{name: "Advanced parameters", description: "Additional parameters with standard defaults; typically you will run GSEA with these parameters set to their default values.", hidden: false},
{name: "Advanced parameters/Algorithmic", hidden: true, parameters: ["scoring.scheme", "metric.for.ranking.genes", "gene.list.sorting.mode", "gene.list.ordering.mode", "max.gene.set.size", "min.gene.set.size", "collapsing.mode.for.probe.sets.with.more.than.one.match", "normalization.mode", "randomization.mode", "omit.features.with.no.symbol.match", "median.for.class.metrics", "number.of.markers", "random.seed", "save.random.ranked.lists", "selected.gene.sets", "dev.mode", "alt.delim"]},
{name: "Advanced parameters/Reporting", hidden: true, parameters: ["plot.graphs.for.the.top.sets.of.each.phenotype", "make.detailed.gene.set.report", "create.svgs", "create.gcts", "create.zip"]}
{name: "Advanced parameters/Reporting", hidden: true, parameters: ["plot.graphs.for.the.top.sets.of.each.phenotype", "make.detailed.gene.set.report", "create.svgs", "create.gcts"]}
]
4 changes: 2 additions & 2 deletions release.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#Thu, 22 Apr 2021 11:20:36 -0700
LSID.noVersion=urn\:lsid\:broad.mit.edu\:cancer.software.genepattern.module.analysis\:00072
release.version=20.2
build.number=4
release.version=20.3
build.number=-1
build.timestamp=Thu, 22 Apr 2021 11\:20\:36 -0700

0 comments on commit 60b948c

Please sign in to comment.