Changes between Version 1 and Version 2 of userguide

Show
Ignore:
Timestamp:
06-10-11 16:11:32 (3 years ago)
Author:
r.w.w.brouwer@…
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • userguide

    v1 v2  
    11= User guide = 
    22 
     3== Samplesheet == 
     4 
     5NARWHAL will obtain sample information from a tab-delimited sample-sheet. The sample-sheet is a tab-delimited format with a fixed column order. Withing the columns, values can be delimited up to 2 levels deep using commas and semicoloms repectively. The format of the sample-sheet is as follows: 
     6 
     7 
     8== Quick start == 
     9 
     10After creating the sample-sheet, NARWHAL can be run using a single command: 
     11 
     12{{{ 
     13# simple run 
     14> ./narwhal.sh -s path_to_sample_sheet path_to_BASECALLS path_to_OUTPUT 
     15}}} 
     16 
     17The narwhal.sh script runs the prepare_run.py and the run_tools.sh scripts in sequence. 
     18 
     19 
     20== Detailed run == 
     21 
     22 
     23== Output ==