Skip to content

Commit

Permalink
updating the README.rst and ChangeLog
Browse files Browse the repository at this point in the history
  • Loading branch information
@alameldin
alameldin committed Feb 25, 2015
1 parent 4788c31 commit 3c21d99
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 7 deletions.
4 changes: 0 additions & 4 deletions ChangeLog
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
2015-02-25 Hussien Alameldin <hussien@msu.edu>

* sandbox/bloom_count.py: renamed to bloom-count.py
* sandbox/bloom_count.pyc: renamed to bloom-count.pyc
* sandbox/bloom_count_intersection.py: renamed to
bloom-count-intersection.py
* sandbox/bloom_count_intersection.pyc: renamed to
bloom-count-intersection.pyc
* sandbox/read_aligner.py: renamed to read-aligner.py
* sandbox/read_aligner.pyc: renamed to read-aligner.pyc

2015-02-25 Tamer A. Mansour <drtamermansour@gmail.com>

Expand Down
6 changes: 3 additions & 3 deletions sandbox/README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ Good ideas to rewrite using newer tools/approaches:

* assembly-diff.py - find sequences that differ between two assemblies
* assembly-diff-2.py - find subsequences that differ between two assemblies
* bloom_count.py - count # of unique k-mers; should be reimplemented with HyperLogLog
* bloom_count_intersection.py - look at unique and disjoint #s of k-mers
* bloom-count.py - count # of unique k-mers; should be reimplemented with HyperLogLog, Renamed from bloom_count.py in commit 4788c31
* bloom-count-intersection.py - look at unique and disjoint #s of k-mers, Renamed from bloom_count_intersection.py in commit 4788c31.
* split-sequences-by-length.py - break up short reads by length

To examine:
Expand All @@ -76,7 +76,7 @@ To examine:
* error-correct-pass2.py - new error correction foo
* find-unpart.py - something to do with finding unpartitioned sequences
* normalize-by-align.py - new error correction foo
* read_aligner.py - new error correction foo
* read-aligner.py - new error correction foo, Renamed from read_aligner.py in commit 4788c31.
* uniqify-sequences.py - print out paths that are unique in the graph
* write-interleave.py - is this used by any protocol etc?

Expand Down

3 comments on commit 3c21d99

@alameldin
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixes issue dib-lab#846

@alameldin
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Is it mergeable?
  • Did it pass the tests?
  • If it introduces new functionality in scripts/ is it tested?
    Check for code coverage with make clean diff-cover
  • Is it well formatted? Look at make pep8, make diff_pylint_report,
    make cppcheck, and make doc output. Use make format and manual
    fixing as needed.
  • Did it change the command-line interface? Only additions are allowed
    without a major version increment. Changing file formats also requires a
    major version number increment.
  • Is it documented in the ChangeLog?
    http://en.wikipedia.org/wiki/Changelog#Format
  • Was a spellchecker run on the source code and documentation after
    changes were made?

@alameldin
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ready to review

Please sign in to comment.