Skip to content
This repository has been archived by the owner on Mar 16, 2022. It is now read-only.

what are the corrected reads? #718

Open
wants to merge 139 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
139 commits
Select commit Hold shift + click to select a range
e17ff77
Shell for FALCON documentation
Nov 2, 2016
35b86a2
setup tweaks
Nov 2, 2016
cd2feab
theme edits
Nov 2, 2016
0900785
cleanup index page
Nov 2, 2016
6a2db61
rough draft of pipelines/parameters/tutorial
Nov 4, 2016
b59678d
updates tweaks and more info
Nov 4, 2016
6efdb56
template
Nov 4, 2016
35ad96c
updated about page
Nov 4, 2016
3630b9a
placeholders for images in about
Nov 4, 2016
c97b847
added fasta file input info
Nov 4, 2016
85d35fb
add fig1.png
Nov 4, 2016
c7fd242
removed fig ref text on about page
skingan Nov 4, 2016
b120892
moved fig on about page
skingan Nov 4, 2016
2c44a9f
formatting and more info
Nov 4, 2016
06ee4b9
Merge branch 'master' of https://github.com/gconcepcion/FALCON
Nov 4, 2016
8293742
starting quick_start doc
skingan Nov 4, 2016
1e039b1
tweaks / reorgs
Nov 7, 2016
0711c52
split pipeline and add more links
Nov 7, 2016
ef8c515
edits on pipeline
skingan Nov 9, 2016
fff277f
edits on pipeline
skingan Nov 9, 2016
b3183af
quick start first pass
Nov 9, 2016
35ceb2c
quick start and add some fc_run.cfgs
Nov 9, 2016
e342cb0
commit cfg files
Nov 9, 2016
ab33563
more additions
Nov 10, 2016
c2f75f5
added cfg files, started tutorial
skingan Nov 10, 2016
c59c280
Merge branch 'master' of github.com:gconcepcion/FALCON
skingan Nov 10, 2016
76ab0c8
added more cfg files and started tutorial
skingan Nov 10, 2016
be002bc
updates to tutorial
skingan Nov 10, 2016
044cf6c
add more to FAQ
Nov 10, 2016
7f2505b
Merge branch 'master' of https://github.com/gconcepcion/FALCON
Nov 10, 2016
96ac469
minor cleanup and fixes
Nov 11, 2016
4ce3317
fix install instrux
Nov 11, 2016
e6911d8
updates on parameters and tutorial
skingan Nov 16, 2016
fdb453f
mostly finished tidying up and unzip stuff
Nov 30, 2016
39be07e
updated dir structure for pipeline doc
skingan Dec 6, 2016
894fece
updates to tutorial, countFasta.pl script added, new fc_run.cfg files…
skingan Jan 6, 2017
d959368
updates to tutorial, R code and plots
skingan Jan 6, 2017
e7e2105
updates to tutorial, addition of histogram images
skingan Jan 9, 2017
30fd620
tutorial done
skingan Jan 13, 2017
9b23774
fixed typo in tutorial
skingan Jan 31, 2017
611b15f
added sequel config file for mammals
skingan Mar 31, 2017
9b57ecf
simpler install
Jun 6, 2017
42c794e
fix typo
Jun 6, 2017
4596dee
fix untracked files
Jun 6, 2017
dcfd2ba
fix script; misc tidying
Jun 7, 2017
02d4207
fixed local cfg file for ecoli tutorial
skingan Jun 9, 2017
3b994b9
updated tutorial
skingan Jun 9, 2017
bc1f068
FALCON
skingan Jun 9, 2017
dfe2185
even simpler install; plus moving scripts
Jun 9, 2017
0ac3efa
Merge branch 'master' of https://github.com/gconcepcion/FALCON
Jun 9, 2017
bfab6ca
expanded about page
skingan Jun 9, 2017
92bd47a
expanded about page
skingan Jun 9, 2017
3e6018b
Merge branch 'master' of https://github.com/gconcepcion/FALCON
Jun 9, 2017
7abbee3
edited tutorial
skingan Jun 9, 2017
a309d6a
edited tutorial
skingan Jun 9, 2017
64c7b93
just install tools
Jun 14, 2017
6f26f5a
fix typos
gconcepcion Jun 14, 2017
585b70b
another typo
gconcepcion Jun 14, 2017
833425d
added usage recs for assemblers to About page
skingan Jun 15, 2017
f6c3827
About page edits
skingan Jun 15, 2017
c52bfa0
edited About page
skingan Jun 15, 2017
2fd60c4
edited index
skingan Jun 15, 2017
31f2e96
spell check
skingan Jun 15, 2017
02b315e
cleaner + testing instructions on small dataset
gconcepcion Jun 16, 2017
5dc4048
thought I alerady pushed this
gconcepcion Jun 16, 2017
cf14bd7
hyperlink typo
gconcepcion Jun 16, 2017
bb1af73
one more cli typo...
gconcepcion Jun 16, 2017
4065117
last one...
gconcepcion Jun 16, 2017
3ec77f2
quickstart example typo
gconcepcion Jun 23, 2017
cd0b5db
pipeline misc update
gconcepcion Jun 23, 2017
949bd6e
fix quick_start example
gconcepcion Jun 26, 2017
19497d9
added UGM slides to tertiary
skingan Jun 27, 2017
40be75c
more typos
gconcepcion Jun 27, 2017
3fcc20e
adding slides
skingan Jun 27, 2017
1e44512
Merge branch 'master' of github.com:gconcepcion/FALCON
skingan Jun 27, 2017
fb1dadf
r
skingan Jun 27, 2017
555601b
adding UGM slides
skingan Jun 27, 2017
6ba0426
fixed kingan talk
skingan Jun 27, 2017
1b83875
more slides
skingan Jun 28, 2017
7f48fc0
more slides
skingan Jun 28, 2017
8140045
more slides
skingan Jun 28, 2017
6b219c8
more slides
skingan Jun 29, 2017
d47ad75
simplify quick_start with updated script to install binareis
gconcepcion Aug 14, 2017
d6af374
simplify test portion
gconcepcion Aug 14, 2017
5de06ed
omit polishing
gconcepcion Aug 16, 2017
12c6aae
even simpler
gconcepcion Aug 16, 2017
fb4067b
proof reading
gconcepcion Aug 16, 2017
5e6edb1
typos
gconcepcion Aug 21, 2017
544489c
path optional
gconcepcion Aug 31, 2017
c78e138
clarify length_cutoff
gconcepcion Sep 5, 2017
f781eb9
add MUMmer 3.23 install
gconcepcion Sep 12, 2017
94b32c7
gcc 4.9.2 dependency
gconcepcion Sep 13, 2017
6bd1c42
src cleanup
gconcepcion Sep 15, 2017
fe8f34f
add seciton to FAQ
gconcepcion Oct 3, 2017
ee7c9a3
minor edits
gconcepcion Oct 3, 2017
f845434
*free* software
gconcepcion Oct 4, 2017
71c0455
typos
gconcepcion Oct 30, 2017
1481e2e
simpler install script - just untarring binaries and building MUMmer
gconcepcion Nov 3, 2017
1a4ab1c
minor tidying
gconcepcion Nov 3, 2017
ec743a3
Renames tertiary page, uploaded some slides
skingan Jan 12, 2018
40542f6
added Zev's talk
skingan Jan 14, 2018
afbcbd0
added more posters and talk from PAGXXVI
skingan Jan 15, 2018
e1ab08d
added figure
skingan Jan 16, 2018
42ea979
added credits
skingan Jan 16, 2018
3d9594c
edits
skingan Jan 16, 2018
423fa77
adding dev conf talks
skingan Jan 17, 2018
8d4cf1d
adding dev conf talks
skingan Jan 17, 2018
6393237
adding dev conf talks
skingan Jan 17, 2018
cccf43d
adding slides
skingan Jan 17, 2018
bcc2fef
more slides
skingan Jan 17, 2018
71104bf
more slides
skingan Jan 17, 2018
3c85000
more slides
skingan Jan 17, 2018
548bc4e
updated liz slides
skingan Jan 17, 2018
8d8c2ae
add Zev
skingan Jan 17, 2018
1a6d580
updated conesa slides
skingan Jan 18, 2018
f7534a3
updated conesa slides
skingan Jan 18, 2018
d0fb428
more talks
skingan Jan 18, 2018
a7d87f0
added Tim's Talk
skingan Jan 24, 2018
4f2ee97
update unzip config
gconcepcion Jan 26, 2018
e19ef02
--no-check-certificate for mummer download
gconcepcion Feb 14, 2018
a5ea166
update to use new binary tarball
gconcepcion Mar 14, 2018
f1e2d7b
Added the docs for the hgap4_adapt script and instructions on how to …
isovic Mar 24, 2018
108f585
Merge pull request #1 from gconcepcion/doc-hgap4_adapt
pb-isovic Mar 27, 2018
230d97c
fix minor python env issue
gconcepcion Apr 2, 2018
4d7b6b5
added FALCON-Phase slides
skingan May 24, 2018
846dc8f
update changelog and install scripts
gconcepcion Jun 18, 2018
e3cf912
update changelog and install scripts
gconcepcion Jun 18, 2018
59c92c1
index/changelog
gconcepcion Jun 18, 2018
fde4c47
sync fork & update quickstart
gconcepcion Jul 26, 2018
a987cef
Merge branch 'master' of https://github.com/PacificBiosciences/FALCON
gconcepcion Jul 26, 2018
2cc9641
update quick_start w/ new tarball
gconcepcion Jul 26, 2018
3e1bd45
forgot to modify changelog link
gconcepcion Jul 26, 2018
9713093
minimap2 req
gconcepcion Jul 26, 2018
cb173d0
this time?
gconcepcion Jul 26, 2018
32a3c7e
comment out sourcing
gconcepcion Jul 26, 2018
ce0d4a6
update quickstart to 8-08 tarball
gconcepcion Aug 16, 2018
3f60044
rm uncessary file & force rebuild
gconcepcion Aug 29, 2018
1b1f93d
obsolete docs & add link to new bioconda pb-assembly install instruct…
gconcepcion Aug 30, 2018
9dd5304
new repo moved
gconcepcion Sep 10, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_build
225 changes: 225 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,225 @@
# Makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " epub3 to make an epub3"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
@echo " dummy to check syntax errors of document sources"

.PHONY: clean
clean:
rm -rf $(BUILDDIR)/*

.PHONY: html
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

.PHONY: dirhtml
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

.PHONY: singlehtml
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

.PHONY: pickle
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."

.PHONY: json
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."

.PHONY: htmlhelp
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."

.PHONY: qthelp
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FALCONDocumentation.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FALCONDocumentation.qhc"

.PHONY: applehelp
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."

.PHONY: devhelp
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/FALCONDocumentation"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FALCONDocumentation"
@echo "# devhelp"

.PHONY: epub
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

.PHONY: epub3
epub3:
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
@echo
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."

.PHONY: latex
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."

.PHONY: latexpdf
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

.PHONY: latexpdfja
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

.PHONY: text
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."

.PHONY: man
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

.PHONY: texinfo
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."

.PHONY: info
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

.PHONY: gettext
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

.PHONY: changes
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."

.PHONY: linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."

.PHONY: doctest
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

.PHONY: coverage
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."

.PHONY: xml
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."

.PHONY: pseudoxml
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

.PHONY: dummy
dummy:
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
@echo
@echo "Build finished. Dummy builder generates no files."
34 changes: 34 additions & 0 deletions docs/OvlpHists.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.. _OvlpHists:

.. image:: media/OvlpHist.png
:height: 500px
:width: 1000 px
:alt: Pread Ovlp Histogram
:align: left


Example R Code
--------------

.. code-block:: R

library(ggplot2)
o<-read.table("ovlp.stats", header=F)
colnames(o)<-c("pread","length","fivePrimeOvlps","threePrimeOvlps")

pdf(file="OvlpHist.pdf", width=11, height=5)
par(oma=c(3,3,2,0), cex=1.6, las=1, mar=c(4,4,2,2), mfrow=c(1,2))
hist(o$fivePrimeOvlps, breaks=100,
xlab="number of overlaps between preads",
ylab="count", main="Five Prime")
hist(o$threePrimeOvlps, breaks=100,
xlab="number of overlaps between preads",
ylab="count", main="Three Prime")
dev.off()



Example Input Files
-------------------

:download:`ovlp.stats <ovlp.stats>`
46 changes: 46 additions & 0 deletions docs/Rhists.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
.. _RHists:

.. image:: media/RawReadHist.png
:height: 700px
:width: 700 px
:alt: Raw Read Histogram
:align: center

.. image:: media/PreadHist.png
:height: 700px
:width: 700 px
:alt: PRead Histogram
:align: center


Example R Code
--------------

.. code-block:: R

setwd("my/dir")
raw<-read.table("raw_reads.stats.txt", header=T)
preads<-read.table("preads.stats.txt",header=T)

pdf(file="RawReadHist.pdf", width=11, height=8.5)
par(oma=c(4,4,2,0), cex=1.6, las=1, mar=c(4,4,2,2))
plot(data=raw, Count~Bin, type="h",col="DeepSkyBlue", lwd=5,
ylab="", xlab="Read Length", main="Raw Reads")
mtext("Read Count", side=2, cex=1.7, las=3, line=4)
dev.off()

pdf(file="PreadHist.pdf", width=11, height=8.5)
par(oma=c(4,4,2,0), cex=1.6, las=1, mar=c(4,4,2,2))
plot(data=preads, Count~Bin, type="h",col="ForestGreen", lwd=5,
ylab="", xlab="Read Length", main="Preassembled Reads")
mtext("Read Count", side=2, cex=1.7, las=3, line=4)
dev.off()



Example Input Files
-------------------

:download:`raw_reads.stats.txt <raw_reads.stats.txt>`

:download:`preads.stats.txt <preads.stats.txt>`