Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GuyTeichman committed Apr 2, 2022
1 parent a0b83ca commit bcb55af
Show file tree
Hide file tree
Showing 380 changed files with 6,021 additions and 24,779 deletions.
2 changes: 1 addition & 1 deletion docs/build/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +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: e5d4c87dbb9b2e3a0be59da5b76a9291
config: 2cadc0d7faf56148d7c993d240bd1a5d
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/build/.doctrees/api_reference.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/authors.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/contributing.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/.doctrees/genindex.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/glossary.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/history.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/installation.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/readme.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.enrichment.FeatureSet.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.enrichment.FeatureSet.union.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.enrichment.RankedSet.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.enrichment.RankedSet.union.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.enrichment.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.enrichment.upset_plot.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.enrichment.venn_diagram.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.CountFilter.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.CountFilter.head.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.CountFilter.pca.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.CountFilter.sort.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.CountFilter.tail.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.CountFilter.union.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.DESeqFilter.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.DESeqFilter.head.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.DESeqFilter.sort.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.DESeqFilter.tail.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.DESeqFilter.union.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.Filter.biotypes.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.Filter.describe.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.Filter.difference.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.Filter.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.Filter.head.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.Filter.save_csv.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.Filter.sort.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.Filter.tail.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.Filter.union.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.FoldChangeFilter.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.Pipeline.apply_to.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.Pipeline.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.filtering.doctree
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.general.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/rnalysis.general.save_to_csv.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/.doctrees/user_guide.doctree
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
rnalysis.filtering.CountFilter.majority\_vote\_intersection
===========================================================

.. currentmodule:: rnalysis.filtering

.. automethod:: CountFilter.majority_vote_intersection
3 changes: 2 additions & 1 deletion docs/build/_sources/rnalysis.filtering.CountFilter.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
rnalysis.filtering.CountFilter
rnalysis.filtering.CountFilter
==============================

.. currentmodule:: rnalysis.filtering
Expand Down Expand Up @@ -33,6 +33,7 @@ rnalysis.filtering.CountFilter
CountFilter.from_folder
CountFilter.head
CountFilter.intersection
CountFilter.majority_vote_intersection
CountFilter.normalize_to_rpm
CountFilter.normalize_with_scaling_factors
CountFilter.number_filters
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
rnalysis.filtering.DESeqFilter.majority\_vote\_intersection
===========================================================

.. currentmodule:: rnalysis.filtering

.. automethod:: DESeqFilter.majority_vote_intersection
3 changes: 2 additions & 1 deletion docs/build/_sources/rnalysis.filtering.DESeqFilter.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
rnalysis.filtering.DESeqFilter
rnalysis.filtering.DESeqFilter
==============================

.. currentmodule:: rnalysis.filtering
Expand Down Expand Up @@ -29,6 +29,7 @@ rnalysis.filtering.DESeqFilter
DESeqFilter.filter_top_n
DESeqFilter.head
DESeqFilter.intersection
DESeqFilter.majority_vote_intersection
DESeqFilter.number_filters
DESeqFilter.print_features
DESeqFilter.save_csv
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
rnalysis.filtering.Filter.majority\_vote\_intersection
======================================================

.. currentmodule:: rnalysis.filtering

.. automethod:: Filter.majority_vote_intersection
3 changes: 2 additions & 1 deletion docs/build/_sources/rnalysis.filtering.Filter.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
rnalysis.filtering.Filter
rnalysis.filtering.Filter
=========================

.. currentmodule:: rnalysis.filtering
Expand Down Expand Up @@ -26,6 +26,7 @@ rnalysis.filtering.Filter
Filter.filter_top_n
Filter.head
Filter.intersection
Filter.majority_vote_intersection
Filter.number_filters
Filter.print_features
Filter.save_csv
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
rnalysis.filtering.FoldChangeFilter.majority\_vote\_intersection
================================================================

.. currentmodule:: rnalysis.filtering

.. automethod:: FoldChangeFilter.majority_vote_intersection
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
rnalysis.filtering.FoldChangeFilter
rnalysis.filtering.FoldChangeFilter
===================================

.. currentmodule:: rnalysis.filtering
Expand Down Expand Up @@ -28,6 +28,7 @@ rnalysis.filtering.FoldChangeFilter
FoldChangeFilter.filter_top_n
FoldChangeFilter.head
FoldChangeFilter.intersection
FoldChangeFilter.majority_vote_intersection
FoldChangeFilter.number_filters
FoldChangeFilter.print_features
FoldChangeFilter.randomization_test
Expand Down
3 changes: 2 additions & 1 deletion docs/build/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -757,6 +757,7 @@ span.pre {
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
white-space: nowrap;
}

div[class*="highlight-"] {
Expand Down
4 changes: 2 additions & 2 deletions docs/build/_static/css/theme.css

Large diffs are not rendered by default.

77 changes: 56 additions & 21 deletions docs/build/_static/doctools.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -154,9 +154,7 @@ var Documentation = {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
this.initOnKeyListeners();
}
this.initOnKeyListeners();
},

/**
Expand Down Expand Up @@ -264,6 +262,16 @@ var Documentation = {
hideSearchWords : function() {
$('#searchbox .highlight-link').fadeOut(300);
$('span.highlighted').removeClass('highlighted');
var url = new URL(window.location);
url.searchParams.delete('highlight');
window.history.replaceState({}, '', url);
},

/**
* helper function to focus on search bar
*/
focusSearchBar : function() {
$('input[name=q]').first().focus();
},

/**
Expand All @@ -288,27 +296,54 @@ var Documentation = {
},

initOnKeyListeners: function() {
// only install a listener if it is really needed
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
return;

$(document).keydown(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box, textarea, dropdown or button
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
&& activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
&& !event.shiftKey) {
switch (event.keyCode) {
case 37: // left
var prevHref = $('link[rel="prev"]').prop('href');
if (prevHref) {
window.location.href = prevHref;
return false;
}
break;
case 39: // right
var nextHref = $('link[rel="next"]').prop('href');
if (nextHref) {
window.location.href = nextHref;
return false;
}
break;
&& activeElementType !== 'BUTTON') {
if (event.altKey || event.ctrlKey || event.metaKey)
return;

if (!event.shiftKey) {
switch (event.key) {
case 'ArrowLeft':
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
break;
var prevHref = $('link[rel="prev"]').prop('href');
if (prevHref) {
window.location.href = prevHref;
return false;
}
break;
case 'ArrowRight':
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
break;
var nextHref = $('link[rel="next"]').prop('href');
if (nextHref) {
window.location.href = nextHref;
return false;
}
break;
case 'Escape':
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
break;
Documentation.hideSearchWords();
return false;
}
}

// some keyboard layouts may need Shift to get /
switch (event.key) {
case '/':
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
break;
Documentation.focusSearchBar();
return false;
}
}
});
Expand Down
6 changes: 4 additions & 2 deletions docs/build/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '2.0.0',
VERSION: '2.0.1',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
FILE_SUFFIX: '.html',
LINK_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false
NAVIGATION_WITH_KEYS: false,
SHOW_SEARCH_SUMMARY: true,
ENABLE_SEARCH_SHORTCUTS: true,
};
2 changes: 1 addition & 1 deletion docs/build/_static/js/theme.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/build/_static/language_data.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
Loading

0 comments on commit bcb55af

Please sign in to comment.