From e72199fcaec7ed75d1a882778919dba74b788cb0 Mon Sep 17 00:00:00 2001 From: Calvin Morrison Date: Thu, 3 Oct 2013 10:16:21 -0400 Subject: Create README.md Get a readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..aa2f232 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +dna-utils +========= + +general utilities for manipulating sequences and fasta files - high performance kmer counting + + +Tools included +============== + +kmer_total_count - this program will count each kmer, and print to standard out. + +arguemnts: fasta_file kmer_size + +example: kmer_total_count SuperManSequences.fasta 8 + +the order of the array corresponds to AAAA, AAAC, AAAG, AAAT and so on -- cgit v1.2.3 From 91ee7c38e7cfe000de8532ba777e8a8e3e6ba4f5 Mon Sep 17 00:00:00 2001 From: Calvin Morrison Date: Thu, 3 Oct 2013 10:19:07 -0400 Subject: Update README.md --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index aa2f232..c217e1c 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,19 @@ -dna-utils -========= +# dna-utils -general utilities for manipulating sequences and fasta files - high performance kmer counting +This repository contains general utilities for processing sequences in fasta files. -Tools included -============== -kmer_total_count - this program will count each kmer, and print to standard out. +### Tools included ### -arguemnts: fasta_file kmer_size -example: kmer_total_count SuperManSequences.fasta 8 +kmer_total_count - this program will count each kmer in a fasta file, and print to standard out. + +#### Usage + + kmer_total_count filename kmer_size + + # Example + calvin@barnabas:~/dna-utils$ ./kmer_total_count SuperManSequences.fasta 8 the order of the array corresponds to AAAA, AAAC, AAAG, AAAT and so on -- cgit v1.2.3