Commit a85c45ed authored by Marie Bourdon's avatar Marie Bourdon
Browse files

add readme

parent a425f3b3
^stuart\.Rproj$
^\.Rproj\.user$
^README\.Rmd$
---
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.
<!-- 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.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment