From 9fb6b79d6ac2deee59366dea975cd881f8bf77c0 Mon Sep 17 00:00:00 2001 From: Christian Arnold <christian.arnold@embl.de> Date: Fri, 17 Nov 2017 16:05:55 +0100 Subject: [PATCH] README.md update --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e8f7bba..20fc0c1 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,33 @@ - + Genome-wide quantification of differential transcription factor activity: diffTF ===================================================== -[Documentation](https://git.embl.de/carnold/diffTF/doc/Documentation.pdf) + Summary ------- Transcription factor (TF) activity constitutes an important readout of cellular signalling pathways and thus for assessing regulatory differences across conditions. However, current technologies lack the ability to simultaneously assessing activity changes for multiple TFs and surprisingly little is known about whether a TF acts as repressor or activator. To this end, we introduce the widely applicable genome-wide method diffTF to assess differential TF binding activity and classifying TFs as activator or repressor by integrating any type of genome-wide chromatin with RNA-Seq data and in-silico predicted TF binding sites +Documentation +------- + +A detailed Documentation is available here: + +[Documentation](https://git.embl.de/carnold/diffTF/blob/master/doc/Documentation.pdf) + Instructions to run the example analysis ----------- -Change into the example/input directory within the Git repository + * Change into the example/input directory within the Git repository ``cd diffTF/example/input`` -Download the data via the download script + * Download the data via the download script ``sh downloadAllData.sh`` -Start a dryrun via the helper script + * Start a dryrun via the helper script ``sh startAnalysis.sh`` -Once the dryrun is successful, change the startAnalysis.sh script and remove the dryrun directive to start the analysis and restart the script. + * Once the dryrun is successful, change the startAnalysis.sh script and remove the dryrun directive to start the analysis and restart the script. ``{EDIT THE FILE}`` ``sh startAnalysis.sh`` -- GitLab