From a85c45ed0e8ac26e4d8d581e533ff26d2d5cdeb9 Mon Sep 17 00:00:00 2001
From: Marie Bourdon <mariebourdon@MacBook-2.local>
Date: Mon, 31 May 2021 18:06:22 +0200
Subject: [PATCH] add readme

---
 stuart/.Rbuildignore |  1 +
 stuart/README.Rmd    | 32 ++++++++++++++++++++++++++++++++
 stuart/README.md     | 28 ++++++++++++++++++++++++++++
 3 files changed, 61 insertions(+)
 create mode 100644 stuart/README.Rmd
 create mode 100644 stuart/README.md

diff --git a/stuart/.Rbuildignore b/stuart/.Rbuildignore
index f0c769d..de527e5 100755
--- a/stuart/.Rbuildignore
+++ b/stuart/.Rbuildignore
@@ -1,2 +1,3 @@
 ^stuart\.Rproj$
 ^\.Rproj\.user$
+^README\.Rmd$
diff --git a/stuart/README.Rmd b/stuart/README.Rmd
new file mode 100644
index 0000000..3312c8e
--- /dev/null
+++ b/stuart/README.Rmd
@@ -0,0 +1,32 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+
+# stuart
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+stuart is a R package used to analyze whole genome genotyping results of animals used by crossing laboratory strains. It is particularly useful for F2 or N2 individuals as it allows to filter the markers in the arrays that can or cannot be used for further analysis from a genetic point of view. Mrkers will be selected depending on their proportion of each genotype, correspondance between F2 or N2 individuals alleles and parental strains alleles, etc.
+
+## Installation
+
+You can install the released version of stuart from GitLab 
+
+``` r
+
+```
+
+## Example
+To see an example of the use of stuart package with miniMUGA array, consult the package vignette.
diff --git a/stuart/README.md b/stuart/README.md
new file mode 100644
index 0000000..2497f6e
--- /dev/null
+++ b/stuart/README.md
@@ -0,0 +1,28 @@
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+# stuart
+
+<!-- badges: start -->
+
+<!-- badges: end -->
+
+stuart is a R package used to analyze whole genome genotyping results of
+animals used by crossing laboratory strains. It is particularly useful
+for F2 or N2 individuals as it allows to filter the markers in the
+arrays that can or cannot be used for further analysis from a genetic
+point of view. Mrkers will be selected depending on their proportion of
+each genotype, correspondance between F2 or N2 individuals alleles and
+parental strains alleles, etc.
+
+## Installation
+
+You can install the released version of stuart from GitLab
+
+``` r
+```
+
+## Example
+
+To see an example of the use of stuart package with miniMUGA array,
+consult the package vignette.
-- 
GitLab