Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
souryacs committed Dec 9, 2022
1 parent b5e539c commit bdc3fb7
Show file tree
Hide file tree
Showing 56 changed files with 18,255 additions and 0 deletions.
Binary file added docs/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/doctrees/index.doctree
Binary file not shown.
Binary file added docs/doctrees/usage/DiffLoops.doctree
Binary file not shown.
Binary file added docs/doctrees/usage/FAQ.doctree
Binary file not shown.
Binary file added docs/doctrees/usage/Utilities.doctree
Binary file not shown.
Binary file added docs/doctrees/usage/configuration.doctree
Binary file not shown.
Binary file added docs/doctrees/usage/installation.doctree
Binary file not shown.
Binary file added docs/doctrees/usage/optional.doctree
Binary file not shown.
Binary file added docs/doctrees/usage/output.doctree
Binary file not shown.
Binary file added docs/doctrees/usage/quickstart.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 99cb246b043f1c5796f9d403ab32cb98
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added docs/html/.nojekyll
Empty file.
78 changes: 78 additions & 0 deletions docs/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
.. FitHiChIP_Doc documentation master file, created by
sphinx-quickstart on Thu Jan 17 15:35:54 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. :caption: Contents:
Welcome to FitHiChIP!
=======================

**Developers**: Sourya Bhattacharyya, Ferhat Ay

**Institution**: Division of Vaccine Discovery, La Jolla Institute for Immunology, La Jolla, CA 92037, USA


Utilities of FitHiChIP at a glance
------------------------------------

- FitHiChIP derives the statistically significant CIS interactions from a given **HiChIP / PLAC-seq**, and now for **Hi-C** data as well.
- CIS Interactions within a specified distance range (default = 20 Kb to 2 Mb: can be user defined) and for a specified fixed size bin size, are computed.
- Distance decay model proposed in the method FitHiC (Ay and Noble, Genome Research 2014) together with a novel bias (coverage / ICE) regression model is used to find the statistical significant interactions.

- Processing HiChIP / PLAC-seq requires specifying ChIP-seq peaks corresponding to the target protein or histone modifications of interest.
- Either user can provide ChIP-seq peak files from ENCODE, ROADMAP, or any other reference.
- Alternatively, **FitHiChIP supports calling peaks from HiChIP data**, which can be used to find out the interactions involving peaks (enriched) segments.

- FitHiChIP also supports finding **differential HiChIP contacts** between two different categories of HiChIP data, having one or more replicates.

- FitHiChIP also proposes a basic implementation of **simulating HiChIP contact map given a reference HiC contact map and a ChIP-seq alignment file**, with respect to specified number of reads. (**Note**: this implementation is still in basic stage; output HiChIP heatmap shows explicit bias towards low range contacts.)

Repository
-----------

FitHiChIP is hosted in https://github.com/ay-lab/FitHiChIP


Execution
----------

Details of execution commands and parameters are provided in the below mentioned links:

.. toctree::
:maxdepth: 2

usage/installation
usage/quickstart
usage/configuration
usage/output
usage/DiffLoops
usage/Utilities
usage/FAQ

.. usage/optional
Citation
-----------
FitHiChIP is now published at Nature Communications (<https://www.nature.com/articles/s41467-019-11950-y>)

If you are using FitHiChIP, please cite:

Sourya Bhattacharyya, Vivek Chandra, Pandurangan Vijayanand, and Ferhat Ay, *Identification of significant chromatin contacts from HiChIP data by FitHiChIP*, Nature Communications, Vol 10, No 4221, 2019, DOI: <https://doi.org/10.1038/s41467-019-11950-y>


Support
-----------

For any queries or problems, user can report an issue in GitHub (<https://github.com/ay-lab/FitHiChIP>). Alternatively, user can mail us in:

- Sourya Bhattacharyya <sourya@lji.org>
- Ferhat Ay <ferhatay@lji.org>

.. Indices and tables
.. ==================
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`
134 changes: 134 additions & 0 deletions docs/html/_static/_sphinx_javascript_frameworks_compat.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
/*
* _sphinx_javascript_frameworks_compat.js
* ~~~~~~~~~~
*
* Compatability shim for jQuery and underscores.js.
*
* WILL BE REMOVED IN Sphinx 6.0
* xref RemovedInSphinx60Warning
*
*/

/**
* select a different prefix for underscore
*/
$u = _.noConflict();


/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};

/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;

/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};

/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};

/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();

var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];

return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
Loading

0 comments on commit bdc3fb7

Please sign in to comment.