Skip to content
Steve Bond edited this page Sep 29, 2015 · 4 revisions

Every tool in the BuddySuite should be documented with a dedicated wiki page. These pages are designed to explain the tool and, perhaps more importantly, provide use cases to illustrate the tool in action. The GitHub wiki pages are written in markdown. If you are not a core developer, please email any new wiki pages to Steve Bond.

The general structure of a BuddySuite wiki page is as follows:

## --tool_name, -tn

### Description
Some text letting people know what the tool does. 
Include references and credit as appropriate.

### Argument(s)
#### Arg1 ( _type_ )
Some text explaining the argument

#### Arg2 ( _type_ )
**Optional**. Explanation

### Example(s)
#### Input file: in_file.fa

    > seq1
    ATGCTCGATGCT
    > seq2
    ATGCCCGCTAGTC

#### Usage example 1

`$: sb in_file.fa -tn arg1`

#### Output

    > seq1
    ATGCTATGCT
    > seq2
    ATGCCTAGTC

#### Usage example 2

`$: sb in_file.fa -tn arg1 arg2`

#### Output

    > seq1
    ATGCTAtgaTGCT
    > seq2
    ATGCCTcgtaAGTC

Main Toolkit Pages





Further Reading

Clone this wiki locally