From e47533cefd80d7373df4d51e2c07cc797aecdb5b Mon Sep 17 00:00:00 2001 From: Ed Harry Date: Mon, 13 Jan 2020 13:45:08 +0000 Subject: [PATCH] updated readme --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8d7277b..6c0b8f1 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # PretextGraph -Converts bedgraph formatted coverage data and embeds inside a Pretext contact map. +Converts bedgraph formatted data and embeds inside a Pretext contact map. # Usage -PretextGraph reads bedgraph formatted coverage information from `stdin`, e.g:
-zcat bedgraph.file.gz | PretextGraph -i input.pretext -n "track name"
+PretextGraph reads bedgraph formatted data from `stdin`, e.g:
+zcat bedgraph.file.gz | PretextGraph -i input.pretext -n "graph name"
bigWigToBedGraph bigwig.file /dev/stdout | PretextGraph -i input.pretext -n "graph name" Important: only non-negative integer data is supported. # Options -i input Pretext file, required. Sequence names in the Pretext file must match sequence names in the bedgraph data; although relative sort order is unimportant.
--n track name, required. A name for the coverage data.
+-n graph name, required. A name for the graph.
--o output Pretext file, optional. If no output is specified the coverage track will be appended to the input file.
+-o output Pretext file, optional. If no output is specified the graph data will be appended to the input file.
# Requirments, running 4 cpu cores