deeptools / HiCBrowser

Simple web browser to visualize HiC tracks
GNU General Public License v2.0
18 stars 5 forks source link

move to .yaml for config? #22

Open vivekbhr opened 6 years ago

vivekbhr commented 6 years ago

Current config (.ini) file has it's own format, while yaml is a popular and easy to use format. Plus I am not sure if current config allows a hierarchy in the dictionary keys obtained after parsing. If we have a hierarchy of keys we can merge the gene config and browser config file into one and then we require only one config at browser startup.

For example:

gene_view:
    boundaries_bed:
        file: /path/to/file
        title: TADs
        color: red
    genes:
        file: /data/test/hicBrowser/GRCm38_genes2.bed 
        title: genes
        color: darkblue
region_view:
    hic_file:
        file: /data/test/hicBrowser/mF1216_merged_10k.h5 
        title: mF1216
        colormap: RdYlBu_r
        depth: 1000000
    bigwig:
        file: /data/test/hicBrowser/H3k4me3.bw 
        title: H3K4me3
fidelram commented 6 years ago

I agree that yaml is probably a better option compared to the config.ini and I will support migrating to this format. However, we have to probably modify the format because the order of the keys is important because this is the order of the tracks afterwards. Also, this change should be made first in pyGenomeBrowser as this should be the reference library.