Skip to content

Commit

Permalink
added release notes and license
Browse files Browse the repository at this point in the history
  • Loading branch information
jewmanchue committed Oct 22, 2014
1 parent 9d32c6e commit f0d30b4
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
24 changes: 24 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
WHAM Version 1.0.0 is under the MIT License.

The MIT License
===============

Copyright (c) 2014 Zev Kronenberg & Mark Yandell

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
25 changes: 25 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
### Release Notes
___

#### Version 1.0.0

Released October 20th 2014

#####Features:

1. Identification of SV breakpoints.
2. Identification of soft-clipped consensus.
3. Provides the end of breakpoints using supplement alignments.
4. Provides genotypes and genotype likelihoods for mulitple individuals.
5. Multi-threading enabled, supported by OpenMP.

#####Known Issues:

1. For large population calling WHAM can hit the Ulimit.
2. For deep regions WHAM has considerable slowdown.
3. Memory becomes an issue for deep regions.

#####Future efforts:
1. Improvements to speed and memory usage.
2. Improve WHAM's breakpoint joining.
3. Improve the LRT for association testing.

0 comments on commit f0d30b4

Please sign in to comment.