Update docs

WGLab · Sep 13, 2023 · 12ff5ab · 12ff5ab
1 parent 6a0dbef
commit 12ff5ab
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 7 deletions.
diff --git a/Doxyfile b/Doxyfile
@@ -943,7 +943,9 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = .
+INPUT                  = include \
+                         src \
+                         docs/project-overview.md \
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

diff --git a/docs/project-outline.md → docs/project-overview.md b/docs/project-outline.md → docs/project-overview.md
@@ -1,11 +1,11 @@
-# ContextSV Outline
+# Project Overview
 
 ## External dependencies
 
 | Dependency | Use | Installation |
 | - | - | - |
 | HTSLib     | Reading BAM files.              | [https://www.biostars.org/p/328831/](https://www.biostars.org/p/328831/) <br /> http://www.htslib.org/download/ |
-| Tensorflow | Importing the SV scoring model. | [https://www.tensorflow.org/install/lang_c](https://www.tensorflow.org/install/lang_c)|
+| scikit-learn | Importing the SV scoring model. | [https://www.tensorflow.org/install/lang_c](https://www.tensorflow.org/install/lang_c)|
 
 ## SV scoring model
 The SV scoring model is trained and saved as a Tensorflow weighted graph in PB file format. It can be trained via the [Python API](https://www.tensorflow.org/api_docs/python/tf). The [C++ API](https://www.tensorflow.org/api_docs/cc) is used to import and utilize this model for scoring SVs.
@@ -38,7 +38,3 @@ ContextSV
         └── lib
             └── ...
 ```
-
-## Tasks by order
-- [x] Draft project structure
-- [ ] CLI with BAM file input