PaintMyChromosomes.com
fineSTRUCTURE v2 & GLOBETROTTER

 Finestructure Icon
  • Home
  • Search
  • Contents

      • fineSTRUCTURE

  • Software
  • Software: R tools
  • Detailed Manual

      • Data

  • Suitable Data
  • Phasing
  • Complex example

      • Methodology

  • Main paper
  • Population Clustering
  • What is a population?
  • GLOBETROTTER Admixture
  • SOURCEFIND Admixture

      • Other

  • Registration & Updates
  • Tools and Scripts
  • FAQs
  • Applications/Links

      • Authors

  • Daniel Lawson
  • Garrett HellenthalDaniel FalushSimon Myers
    • © 2012 Daniel Lawson.
    Website template by Arcsin

    [next] [prev] [prev-tail] [tail] [up]

    3 Overview of FineSTRUCTURE and the help system

    The program includes inline help which you can access from the command line. These are reproduced here verbatim from the current version of the program. All of the help in this document can be accessed via the command line.

    3.1 Information about the processing pipeline


    Listing 3: Overview help
    > fs -h info
     
    ⋆⋆⋆⋆⋆ FineSTRUCTURE and ChromoPainter ⋆⋆⋆⋆⋆ 
    USAGE: "fs <projectname>.cp <options> <actions>" 
    SUMMARY: 
        ⋆ Creates <projectname>.cp and a directory <projectname>. 
        ⋆ Performs inference using ChromoPainter and FineSTRUCTURE. 
        ⋆ Can create commands to be run on an external HPC machine. 
        ⋆ Supports parallel processing in a single machine, obtain finestructure results from a single command. 
        ⋆ This is helper software to easily run chromopainter and finestructure, which are built in to this program. 
    OVERVIEW OF USE: 
        ⋆ Provide SNP data with -phasefiles, recombination data with -recombfiles and individual data with -idfile 
        ⋆ Configure any advanced parameters 
        ⋆ And -go: fs will figure out the rest! 
        ⋆ If using -hpc mode, run "fs" on the head node, which will not run the model. Instead four "stages" of processing 
    are created for running on a external HPC system. Then rerun this program once they have completed to generate the next 
    stage. 
    USE "fs -h" for help on the automatic mode. 

    3.2 Basic Help for ‘automatic mode’


    Listing 4: Basic Help
    > fs -h
     
    ⋆⋆⋆⋆⋆ Help for fs - running the whole chromopainter/finestructure inference pipeline in 'automatic' mode ⋆⋆⋆⋆⋆ 
    USAGE: "fs <projectname>.cp <options> <actions>" 
    GENERAL OPTIONS FOR "project" tool: 
        -h/-help:    Show this help. 
        -help info: Show 'overview' help explaining how this software works. 
        -help actions: Show help for all actions. 
        -help parameters: Show help for all parameters. 
        -help <list of commands or parameters>: Show help on any specific commands or parameters. 
        -help input: Show examples and give details of the input file formats. 
        -help output: Details of the files that may be created. 
        -help stages: Detailed description of what happens in, and between, each stage of the computation. 
        -help tools: Show help on how to access the chromopainter/chromocombine/finestructure tools directly. 
        -help example: Create and show help for a simple example. 
        <tool> -h: Show help on a particular tool: one of fs,cp,combine. IMPORTANT NOTE: These have simplified interfaces 
    with different names when running in automatic mode. The help for automatic mode parameters explains which parameters 
    it changes. 
        -v      :    Verbose mode 
        -n      :    New settings file, overwriting any previous file 
        -<parameter>:<value> : Sets the internal parameter, exactly as if they were read in from -import. 
    The colon is optional, unless <value> starts with a '-' symbol. Escape spaces and don't use quotes; 
    e.g. '-s1args:-in\ -iM'. 
     
    IMPORTANT PARAMETERS: 
    idfile : IDfile location, containing the labels of each individual. REQUIRED, no default (unless -createids is used). 
    phasefiles : Comma or space separated list of all 'phase' files containing the (phased) SNP details for each haplotype. 
    Required. Must be sorted alphanumerically to ensure chromosomes are correctly ordered. So don't use ⋆.phase, use 
    file{1..22}.phase. Override this with upper case -PHASEFILES. 
    recombfiles : Comma or space separated list of all recombination map files containing the recombination distance 
    between SNPs. If provided, a linked analysis is performed. Otherwise an 'unlinked' analysis is performed. Note that 
    linkage is very important for dense markers! 
    IMPORTANT ACTIONS: 
       -go : Do the next things that are necessary to get a complete set of finestructure runs. 
       -import <file> : Import some settings from an external file. If you need to set any non-trivial settings, this is 
    the way to do it. See "fs -hh" for more details. 
       -createid <filename> : Create an ID file from a PROVIDED phase file. Individuals are labelled IND1-IND<N>.

    [next] [prev] [prev-tail] [front] [up]