From 0462c446e1c1ff2dd1708e7f397e8eef0fa1f6d3 Mon Sep 17 00:00:00 2001
From: Kenzo-Hugo Hillion <kenzo-hugo.hillion1@pasteur.fr>
Date: Tue, 17 Mar 2020 12:07:11 +0100
Subject: [PATCH] Start README for workflow

---
 tools/utils/cat/example_usage/config.yaml |  2 +-
 workflows/eggnogmapperv2/README.md        | 10 ++++++++++
 2 files changed, 11 insertions(+), 1 deletion(-)
 create mode 100644 workflows/eggnogmapperv2/README.md

diff --git a/tools/utils/cat/example_usage/config.yaml b/tools/utils/cat/example_usage/config.yaml
index f74b24f..b0d0444 100644
--- a/tools/utils/cat/example_usage/config.yaml
+++ b/tools/utils/cat/example_usage/config.yaml
@@ -10,4 +10,4 @@ samples:
 - test_00002
 
 cat:
-  name_merge: all.emapper.seed_orthologs 
+  name_merge: all.emapper.seed_orthologs
diff --git a/workflows/eggnogmapperv2/README.md b/workflows/eggnogmapperv2/README.md
new file mode 100644
index 0000000..008482c
--- /dev/null
+++ b/workflows/eggnogmapperv2/README.md
@@ -0,0 +1,10 @@
+# EggNOG mapper v2
+
+This describes a workflow to run [eggnog mapper on a large dataset](https://github.com/eggnogdb/eggnog-mapper/wiki/eggNOG-mapper-v2#setting-up-large-annotation-jobs)
+
+In brief it contains 4 steps:
+
+* Splitting the input FASTA files into chunks
+* Run diamond from eggnogmapper on each chunks
+* Merge all results to one unique `emapper.seed_orthologs`
+* Perform annotations from this unique file
-- 
GitLab