Skip to content

Commit

Permalink
add yaml headers to all md files.
Browse files Browse the repository at this point in the history
This should be done for all future md files.
  • Loading branch information
zkamvar committed Mar 24, 2015
1 parent 8f40d24 commit 0a994eb
Show file tree
Hide file tree
Showing 12 changed files with 37 additions and 18 deletions.
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
#Creating and submitting workflow vignettes
---
title: "Creating and submitting workflow vignettes"
---

##What is a workflow vignette?
Workflow vignettes are documents that outline a population genetics based bioinformatics workflow involving one or more R packages. These workflows are based around biological questions/topics and the type of data used. They are generally more extensive than those found in package vignettes and are intended to provide R users with the necessary code and examples to solve biological questions.
Expand All @@ -9,7 +11,7 @@ The analyses outlined in the vignettes should be fast to run, ideally approximat
Anyone who is confident in population genetics analysis in R is encouraged to contribute.

##How do I write a workflow vignette?
Write the workflow vignette in [R markdown] (http://rmarkdown.rstudio.com/). The workflow should include example analysis and explanations using data that can be readily accessed in the public domain e.g. the data that comes as part of some packages so that users can replicate the analysis themselves. If no public data is available to address a particular biological question that you want to write a workflow for, this data can be uploaded to this repository also.
Write the workflow vignette in [R markdown](http://rmarkdown.rstudio.com/). The workflow should include example analysis and explanations using data that can be readily accessed in the public domain e.g. the data that comes as part of some packages so that users can replicate the analysis themselves. If no public data is available to address a particular biological question that you want to write a workflow for, this data can be uploaded to this repository also.

##How do I submit a workflow?
1. Set up a github account if you don't already have one, see [here](https://guides.github.com/activities/hello-world/) for a quick tutorial on using Github. Download the appropriate Git for your computer, see [here](https://help.github.com/articles/set-up-git/), and set it up.
Expand Down
5 changes: 3 additions & 2 deletions DATAFORMATS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Data classes
========
---
title: "Data classes"
---

Class (package) | Strengths | Weaknesses
--- | --- | ---
Expand Down
5 changes: 3 additions & 2 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Workflows for developing R packages
=========================
---
title: "Workflows for developing R packages"
---

* [Available packages](PACKAGES.md)
* [Data formats](DATAFORMATS.md)
Expand Down
4 changes: 3 additions & 1 deletion GETSTARTED.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Get started using R
---
title: "Get started using R"
---

* [Install R](http://cran.r-project.org/)
* [R Reference Card](http://cran.r-project.org/doc/contrib/Short-refcard.pdf)
Expand Down
4 changes: 3 additions & 1 deletion LEARN.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Learn how to use R for population genetics
---
title: "Learn how to use R for population genetics"
---

## Primers in population genetics for specific R packages

Expand Down
5 changes: 3 additions & 2 deletions LOAD_PACKAGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Loading packages
===================
---
title: "Loading packages"
---

Installing required R packages:
-----
Expand Down
5 changes: 3 additions & 2 deletions PACKAGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Packages available in R
========
---
title: "Packages available in R"
---

Package | Title
-----------|------------
Expand Down
4 changes: 3 additions & 1 deletion SNP.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Analyses for SNP data
---
title: "Analyses for SNP data"
---

The following workflows will attempt to answer questions related to SNP data.

4 changes: 3 additions & 1 deletion SSR.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Workflows for microsatellite (SSR) data.
---
title: "Workflows for microsatellite (SSR) data."
---

The following pages will containg workflows for SSR data.
4 changes: 3 additions & 1 deletion USINGR.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Using R for population genetics
---
title: "Using R for population genetics"
---

## Workflows to address specific biological questions

Expand Down
5 changes: 3 additions & 2 deletions WORKFLOWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Common Workflows in R
================
---
title: "Common Workflows in R"
---

This files will list common questions and resulting workflows for users.

Expand Down
4 changes: 3 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Population Genetics in R
---
title: "Population Genetics in R"
---

Please use the menu bar above to navigate through this site.

Expand Down

0 comments on commit 0a994eb

Please sign in to comment.