added description of output/input in the doc

dalloliogm · Dec 12, 2008 · e10fb72 · e10fb72
1 parent 086b23f
commit e10fb72
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/data/filter_24nov.zip b/data/filter_24nov.zip
diff --git a/results/filter_25nov.zip b/results/filter_25nov.zip
diff --git a/src/filter_genes.py b/src/filter_genes.py
@@ -5,9 +5,13 @@
 Usage:
 	python filter_genes.py --genes <genes_file> --window <sliding windows results file> --output <output file>
 
->>> from StringIO import StringIO		# This module is to create fake files,
+The genes file contains the start and end coordinates of every gene.
-...										# to be used for testing purposes.
+The sliding_windows_file contains the coordinates of sliding windows that have been run over the same
-...										# don't worry about it.
+sequences in the gene file.
+The output of this script is a file in which the sliding windows which fall inside a gene have been selected.
+
+
+>>> from StringIO import StringIO		# don't worry about this statement
 >>> genes_file = StringIO('''
 ... #Gene   Position        initial.pos     Final.pos
 ... B3GALT1 chr1    1000	2000