Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kcleal committed Jul 26, 2024
1 parent 9d93e4b commit 44aeddc
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 10 deletions.
46 changes: 40 additions & 6 deletions docs/docs/guide/Genomes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,19 @@ nav_order: 1

# Genomes

GW can load online reference genomes, although it is always best to
use a local file.

To add or update a reference genome path and tag:

1. Click on the Settings menu (click on cog)
2. Goto Genomes menu
3. Click on the "+" button at the top
4. Type the name of the genome-tag you want e.g. `hg19`. If it exists already it will be updated. Hit ENTER
5. Type the path to the local file. Hit ENTER.
6. Optionally click the save button at the top. This will ensure that the genome-tag is saved to your config file.

Once you have configured the path, the genome-tag will then point to your local file.


# Ideograms
Expand All @@ -16,20 +28,42 @@ nav_order: 1
Many of the reference genomes come with a preset ideogram and will be loaded automatically
when a matching genome tag is used e.g. 'hg19' or 't2t' etc.

To configure GW to use an ideogram for a genome tag add this to the 'tracks'
section of settings (or your .gw.ini file)::
You can also load ideograms easily by typing the command:

load ideogram hg19/t2t/hg38 # Choose the appropriate genome-tag

To remove the ideogram use the remove command:

remove ideogram

To configure GW to use a custom ideogram for a genome-tag add this to the 'tracks'
section of settings (or your .gw.ini file):

[tracks]
hg38_ideogram=path_to_ideogram.bed

This will set the ideogram path for the 'hg38' genome tag. Once this has been saved
in the settings menu, the ideogram will be loaded whenever the hg38 genome tag is used.
For example, using the load command::
This will set the ideogram path for the 'hg38' genome-tag. Once this has been saved
in the settings menu, the ideogram will be loaded whenever the hg38 genome-tag is used.
For example, using the load command:

load genome hg38

Or when using 'hg38' tag from the command line.

The CLI interface also has the `--ideogram` option
The CLI interface also has the `--ideogram` option.

---

Any bed file can be used as an ideogram, and adding more than one ideogram will
stack them on top of another. Idograms can be customised with different colours by
adding in ARGB values into the header of your bed file. For example:

#gw LTR5 255,255,0,0
chr1 10000 20000

The `#gw` header line will configure records with LTR5 in the name column to be a
bright red colour on the ideogram.




2 changes: 1 addition & 1 deletion docs/docs/guide/User_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: User guide
layout: default
has_children: true
nav_order: 4
nav_order: 5
---

# User guide
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ quide for MacOS, but Linux or Windows is more or less the same.

Firstly, here are some links for some test data:

[Test bam file](https://kcleal.github.io/gw/docs/assets/data/demo1.bam)
[Test bam file](/assets/data/demo1.bam)

[Test bed file](https://kcleal.github.io/gw/docs/assets/data/demo1.bed)
[Test bed file](/assets/data/demo1.bed)

[Test vcf file](https://kcleal.github.io/gw/docs/assets/data/demo1.vcf)
[Test vcf file](/assets/data/demo1.vcf)

## Launch GW

Expand Down

0 comments on commit 44aeddc

Please sign in to comment.