Skip to content

Commit

Permalink
Initial upload
Browse files Browse the repository at this point in the history
  • Loading branch information
iracooke committed Dec 19, 2016
1 parent 4def6c4 commit e8818cc
Show file tree
Hide file tree
Showing 10 changed files with 72 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
proteinGroups.txt
*.fastq
*.gz
4 changes: 4 additions & 0 deletions R/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# R Code

Use this directory to place R scripts with R code that is specific to the project. General re-usable R code should probably be put into an R package but one-off functions can be placed here.

4 changes: 4 additions & 0 deletions R/helper_functions.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
factor_colours <- function(values){
f=factor(values)
rainbow(length(levels(f)))[as.integer(f)]
}
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
# project-template
Template for Data Analysis Projects
#Data Analysis Project Template

This is your project readme file. You can have other readme files but this one will be displayed at the root of your github repository. This file serves as the entry point for people who want to check out your repository. They should be able to read this an rerun your analyses.



3 changes: 3 additions & 0 deletions bin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Scripts and other programs

If you write non-trivial scripts to perform your analysis include those scripts here.
25 changes: 25 additions & 0 deletions example.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Example Analysis"
output: html_document
---

```{r global_options, include=FALSE}
knitr::opts_chunk$set(fig.width=12, fig.height=8,
echo=FALSE, warning=FALSE, message=FALSE)
knitr::opts_chunk$set(cache=FALSE)
options(width = 60)
library(ggplot2)
library(stringr)
library(dplyr)
library(tidyr)
```

Example analysis

```{r read_data}
table <- read.table("raw_data/counts.txt")
```

```{r make_figure}
```
3 changes: 3 additions & 0 deletions figures/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Figures

Often the result of an R script is a figure to be included in a paper or presentation. Send your figure outputs to this directory
8 changes: 8 additions & 0 deletions hpc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# HPC Processing

Many project require extensive processing of very large data files before an R based data analysis can begin. Those steps should be captured in this directory. Typically this would include

- Instructions on obtaining the raw data
- Shell scripts or pipeline code used to process the raw data
- README files documenting how to run the pipeline steps (perhaps showing the order of steps) and documenting any other commands that need to be run

12 changes: 12 additions & 0 deletions raw_data/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Raw Data

This directory is for analysis ready files that we treat as raw data for the purpose of R analysis. For example RNA-seq counts files or `proteinGroups.txt` files fall in this category. They should not be checked in to git but this readme should provide details of how to get them. For example, in a code block like this;

`proteinGroups.txt` can be obtained as follows;

```bash
wget https://www.dropbox.com/s/dsnp6cmn/proteinGroups.txt?dl=0 -O proteinGroups.txt
```

Or if the data is private or requires authentication provide a link to the website where the user can interactively download the file.

4 changes: 4 additions & 0 deletions results/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Intermediate Results

This directory contains intermediate files that are produced as part of an analysis. These intermediate files should not be checked in to git but you may also place shell scripts or other code for intermediate file processing here. Those shell scripts should be checked in.

0 comments on commit e8818cc

Please sign in to comment.