Skip to content

Commit

Permalink
- Updated docs
Browse files Browse the repository at this point in the history
- Added LICENSE
  • Loading branch information
cannin committed Oct 30, 2011
1 parent bcb1c51 commit 728ff31
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
13 changes: 13 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3 changes: 2 additions & 1 deletion docs/introduction.textile
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ h2. What do snp.plotter images look like?

Here is a sample image as both a PDF and a EPS image. PDF images can be viewed using the free "Adobe Reader":http://www.adobe.com/products/acrobat.html software. EPS (or PDF) images can be viewed using front-end software for "Ghostscript":http://www.cs.wisc.edu/~ghost/, a Postscript and PDF interpreter: "Ghostview and GV":http://www.cs.wisc.edu/~ghost/ for Unix/X11 systems and "GSView":http://www.cs.wisc.edu/~ghost/ for Windows.

[[https://github.com/cannin/snp_plotter/raw/master/docs/null_rsq_phys_color.png]]

h2. Who are the intended users of snp.plotter?

Researchers conducting gene association studies who need to create images showing results in the form of p-values of their work along with a "linkage disequilibrium":http://en.wikipedia.org/wiki/Linkage_disequilibrium plot to show the underlying structure of the study population. Because snp.plotter is a visualization tool, the type of study design used either family-based, case-control, or a combination is irrelevant.
Expand All @@ -26,4 +28,3 @@ h2. What are the main features of snp.plotter?
** Colors/color schemes
** LD metric
** P-value threshold

0 comments on commit 728ff31

Please sign in to comment.