-
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Ben J. Ward
committed
Jan 17, 2020
1 parent
d2215b5
commit ae9e152
Showing
13 changed files
with
475 additions
and
1,879 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,26 @@ | ||
using Documenter, GenomeGraphs | ||
using Documenter, GenomeGraphs, Pkg | ||
|
||
makedocs( | ||
modules = [GenomeGraphs, GenomeGraphs.Graphs], | ||
modules = [GenomeGraphs, GenomeGraphs.Graphs, GenomeGraphs.MerTools], | ||
format = Documenter.HTML(), | ||
sitename = "GenomeGraphs.jl", | ||
authors = "Ben J. Ward & Arda Akdemir", | ||
authors = replace(join(Pkg.TOML.parsefile("Project.toml")["authors"], ", "), r" <.*?>" => "" ), | ||
pages = [ | ||
"Home" => "index.md", | ||
"Manual" => [ | ||
"Guide" => "man/guide.md" | ||
], | ||
"API" => [ | ||
"Graphs submodule" => "api/Graphs.md" | ||
"Graphs submodule" => "api/Graphs.md", | ||
"MerTools submodule" => "api/MerTools.md" | ||
] | ||
], | ||
|
||
) | ||
|
||
deploydocs( | ||
repo = "github.com/BioJulia/GenomeGraphs.jl.git", | ||
push_preview = true, | ||
deps = nothing, | ||
make = nothing | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
```@meta | ||
CurrentModule = GenomeGraphs.MerTools | ||
``` | ||
|
||
# API: The MerTools submodule | ||
|
||
|
||
|
||
!!! note | ||
This is a reference of an internal sub-module's API for developers and | ||
experienced users. First ask yourself if what you need isn't covered by | ||
the higher-level WorkSpace API. | ||
|
||
## Types | ||
|
||
```@docs | ||
MerCount | ||
MerCountHist | ||
DNAMerCount | ||
RNAMerCount | ||
``` | ||
|
||
## Public / Safe methods | ||
|
||
```@docs | ||
mer | ||
freq | ||
collapse_into_counts | ||
collapse_into_counts! | ||
merge_into! | ||
build_freq_list | ||
``` | ||
|
||
## Internal / Unsafe methods | ||
|
||
```@docs | ||
unsafe_collapse_into_counts! | ||
unsafe_merge_into! | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.