From 275593929041fc5c177ee4ea1df3fa9b6fd7d954 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Florian=20Franck=20Priv=C3=A9?= Date: Mon, 9 Dec 2019 10:44:14 +0100 Subject: [PATCH] README v1 --- .gitignore | 6 ++++++ README.md | 40 ++++++++++++++++++++++++++++++++++++++-- 2 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5bd24a5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +.Rproj.user +.Rhistory +.RData +.Ruserdata +README.html +wiki-genetics.Rproj diff --git a/README.md b/README.md index 1ea712c..eae550f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ -# wiki-genetics -Wiki to gather and build knowledge about best practices for genetic analyses. +### Welcome to the iPSYCH community wiki! + +This is wiki aims at gathering and building knowledge about best practices for genetic analyses, particularly of the iPSYCH data. + +Learn more about iPSYCH there: https://ipsych.dk/en/. + +Remember that this is a public space, make sure not to disclose any information that would breach ethics approvals of the data. + +### How to contribute? + +- Small (but useful!) contibutions: + + - **opening an issue about some missing/unclear information**; whenever you have to search for some question or someone ask you a question about genetic analyses or/and iPSYCH data, please open an issue here to document that this piece of information is missing to this wiki + + - **participating in topic discussions** (in issues), e.g. mentioning missing information, useful references or external links + + - **clarifying a point in a wiki page** by adding a few sentences + + - **correcting typos** + +- Larger contributions: + + - **making wiki pages** + + - **reviewing wiki pages** (including code), by someone who is *not* expert in the corresponding topic + + +### Guidelines + +- be nice with others and welcoming to new contributors + +- always open a new issue when you think about missing information (it does *not* have to be you that add ) + +- each page should have is own corresponding issue + +- split the issues and pages as much as possible, e.g. making a GWAS using PLINK and making a GWAS using BOLT are two different issues pages + +- for complex analyses (all main ones basically), it would be good to work within teams (of e.g. two people)