Skip to content

Commit

Permalink
Add man page for sequences summary
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelbarton committed Jan 22, 2013
1 parent d3fde9a commit c529cbc
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 1 deletion.
10 changes: 9 additions & 1 deletion features/sequences.feature
@@ -1,7 +1,15 @@
Feature: Producing a summary of the scaffold sequences
In order to have an overview of the sequences in a scaffold
A user can use the "sequence" command
to generate the a tabular output of the scaffold sequences
to generate a tabular output of the scaffold sequences

@disable-bundler
Scenario: Getting the man page for the scaffold sequences summary
Given I create a new genomer project
When I run `genomer man summary sequences`
Then the exit status should be 0
And the output should contain a valid man page
And the output should contain "GENOMER-SUMMARY-SEQUENCES(1)"

@disable-bundler
Scenario: An empty scaffold
Expand Down
50 changes: 50 additions & 0 deletions man/genomer-summary-sequences.ronn
@@ -0,0 +1,50 @@
# GENOMER-SUMMARY-SEQUENCES 1

## NAME

genomer-summary-sequences(1) -- summarise the sequences in the scaffold

## SYNOPSIS

`genomer summary sequences [<--output=csv>]`

## DESCRIPTION

Generates a summary of the sequences used to build the scaffold. The
output may be generated in CSV format if preferred using the <--output=csv>
option. This summary produces a table with the following attributes:

* Contig:

The identifier of the sequence in the scaffold.

* Start:

The start position of the sequence in the final scaffold sequence.

* End:

The end position of the sequence in the final scaffold sequence.

* Size (bp):

The size of the sequence in the final scaffold sequence.

* Size (%):

The size of the sequence in the final scaffold sequence as a percentage of
the total sequence.

* GC:

The G+C content of the sequence as percentage the total GCAT length of the
sequence.

## BUGS

**Genomer-summary** is written in Ruby and uses several RubyGem dependencies.
See the .gemspec file in the install directory for version details.

## COPYRIGHT

**Genomer** is Copyright (C) 2011 Michael Barton <http://michaelbarton.me.uk>

0 comments on commit c529cbc

Please sign in to comment.