Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs v2: local bam files` #110

Open
manzt opened this issue Feb 28, 2023 · 1 comment
Open

docs v2: local bam files` #110

manzt opened this issue Feb 28, 2023 · 1 comment

Comments

@manzt
Copy link
Member

manzt commented Feb 28, 2023


BAM Files
---------

View sequencing read mappings. First we must load the `higlass-pileup plugin track <https://github.com/higlass/higlass-pileup>`_
as a ``hg.PluginTrack``:



.. code-block:: python

	%%javascript

	require(["https://unpkg.com/higlass-pileup/dist/higlass-pileup.min.js"],
	    function(hglib) {

	});

And then we can view pileups:

.. code-block:: python

	import higlass
	from higlass.tilesets import Tileset, bam
	from higlass.client import Track, View

	filename = '../data/ont.10K.bam'
	indexfile = '../data/ont.10K.bam.bai'

	bam_ts = bam(filename, indexfile)

	display, server, viewconf = higlass.display(
	    [View([
	        Track('top-axis', height=20),
	        Track(track_type="pileup",
	        	position='top', tileset=bam_ts, height=50 )
	    ], initialXDomain = [
	        0,
	        2000
	      ])]
	)
	display

.. image:: img/jupyter-pileup-no-code.png

Usage of the BAM files is shown in the plugin documentation, but we don't currently support local files and would need to extend the server.

@manzt
Copy link
Member Author

manzt commented Jul 14, 2023

@nvictus maybe an oxbow use case

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant