documentation

arontommi · Jan 12, 2018 · fb08dc1 · fb08dc1
1 parent ef6117b
commit fb08dc1
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 9 deletions.
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/Readme.md b/Readme.md
@@ -5,7 +5,15 @@
 
 additional objects are for the writer to improve software documentasion as well as use click to manage inputs
 
-it is possible to run multiple files by using a simple headerless csv
+for simple regions in single patient it is possible to give parameters
+
+paramenters
+
+    -- inputfile : a bam file
+    -- region : region, example : 1:1500-3000 important note, make sure to know if you are supposed to use Chr in front or not
+    -- outputfile : a subsetted bamfile
+
+it it is also possible to run multiple files by using a simple headerless csv
 
 ##### example of csv :