Skip to content

Commit

Permalink
Corrected links to files
Browse files Browse the repository at this point in the history
  • Loading branch information
SvitlanaLukicheva authored Dec 20, 2023
1 parent 0dc6d42 commit 42dcb8f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The [OUTPUTS folder](OUTPUTS/) contains four sub-folders + the log file:
- miniexExample_rankedRegulons.xlsx (also available in tsv format), an excel file containing metadata for each of the inferred regulons. The different columns are explained below:
- TF: TF gene name (i.e. AT1G71930)
- alias: TF alias (i.e. VND7)
- hasTFrelevantGOterm: 'relevant_known_TF' if the TF is associated to a relevant GO term (relative to [GOsIwant.txt](https://github.com/VIB-PSB/MINI-EX/tree/main/example/INPUTS/GOsIwant.txt)), 'known_TF' if the TF is associated to another experimentally validated and/or manually curated GO term, 'unknown_TF' when the TF is uncharacterized
- hasTFrelevantGOterm: 'relevant_known_TF' if the TF is associated to a relevant GO term (relative to [GOsIwant.tsv](https://github.com/VIB-PSB/MINI-EX/tree/main/example/INPUTS/GOsIwant.tsv)), 'known_TF' if the TF is associated to another experimentally validated and/or manually curated GO term, 'unknown_TF' when the TF is uncharacterized
- GO: the GO term(s) the TF is associated with
- GOdescription: the description of the GO term(s) associated with the TF
- cluster: the cell cluster the TF acts in
Expand All @@ -38,7 +38,7 @@ The [OUTPUTS folder](OUTPUTS/) contains four sub-folders + the log file:
- closeness: closeness-centrality
- betweenness: betweenness-centrality
- GO_enrich_qval (only present if 'termsOfInterest' is not null): FDR-corrected p-value of functional enrichment of the regulon's TGs (functional specificity - reporting only the lowest p-value among the relevant terms)
- GO_enrich_term (only present if 'termsOfInterest' is not null): the relevant GO term (relative to [GOsIwant.txt](https://github.com/VIB-PSB/MINI-EX/tree/main/example/INPUTS/GOsIwant.txt)) for which the regulon's TGs showed the most significant enrichment
- GO_enrich_term (only present if 'termsOfInterest' is not null): the relevant GO term (relative to [GOsIwant.tsv](https://github.com/VIB-PSB/MINI-EX/tree/main/example/INPUTS/GOsIwant.tsv)) for which the regulon's TGs showed the most significant enrichment
- GO_enrich_desc (only present if 'termsOfInterest' is not null): description of the GO term for which the regulon's TGs showed the most significant enrichment
- #TGs_withGO (only present if 'termsOfInterest' is not null): number of TGs enriched for the most significant relevant GO term
- borda_rank: global Borda ranking of the regulon
Expand All @@ -54,6 +54,6 @@ The [OUTPUTS folder](OUTPUTS/) contains four sub-folders + the log file:
- miniexExample_heatmapDEcalls, a clustermap reporting whether the top 150 TFs are upregulated (blue) or just expressed (by at least 10% of the cells within the cell cluster - white) in the cell cluster they act. Each TF is color coded accoring to the GO terms associated to it, in green for 'relevant_known_TF', in yellow for 'known_TF', and gray for 'unknown_TF'
![miniexExample_heatmapDEcalls.svg](OUTPUTS/figures/miniexExample_heatmapDEcalls.svg)
- miniexExample_regmap_x, a heatmap reporting top x TFs (default x range: 10, 25, 50, 100, "topRegs", all) per cluster, showing the maximum expression (mean of top 3 cells) per cluster and the respective ranking (borda_clusterRank). Clusters (i.e. columns) are sorted based on the index given in `miniexExample_identities_with_idx.txt`, allowing to track predicted regulators over predefined lineage. If `miniexExample_identities.txt` is provided instead, the clusters will be ordered as provided in this input file. These figures can be easily produced for additional thresholds/settings using the additionally provided `regmap.sh` script. Call `python3 bin/MINIEX_regmap.py -h` for additional parameters. Note: only regmaps having less than 40 TFs are generated in the PNG format
- miniexExample_regmap_x, a heatmap reporting top x TFs (default x range: 10, 25, 50, 100, "topRegs", all) per cluster, showing the maximum expression (mean of top 3 cells) per cluster and the respective ranking (borda_clusterRank). Clusters (i.e. columns) are sorted based on the index given in `miniexExample_identities_with_idx.tsv`, allowing to track predicted regulators over predefined lineage. If `miniexExample_identities.tsv` is provided instead, the clusters will be ordered as provided in this input file. These figures can be easily produced for additional thresholds/settings using the additionally provided `regmap.sh` script. Call `python3 bin/MINIEX_regmap.py -h` for additional parameters. Note: only regmaps having less than 40 TFs are generated in the PNG format

![miniexExample_regmap_25.svg](OUTPUTS/figures/miniexExample_regmap_8.svg)

0 comments on commit 42dcb8f

Please sign in to comment.