Skip to content

Commit

Permalink
add vignette stub
Browse files Browse the repository at this point in the history
  • Loading branch information
[email protected] committed May 14, 2015
1 parent 44ddba0 commit 4e76d04
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
4 changes: 3 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ Description: The SummarizedExperiment container contains one or more assays,
each represented by a matrix-like object of numeric or other mode.
The rows typically represent genomic ranges of interest and the columns
represent samples.
Version: 0.1.3
Version: 0.1.4
Author: Martin Morgan, Valerie Obenchain, Jim Hester, Herv\'e Pag\`es
Maintainer: Bioconductor Package Maintainer <[email protected]>
biocViews: Genetics, Infrastructure, Sequencing, Annotation, Coverage,
GenomeAnnotation
Depends: R (>= 3.2), methods, GenomicRanges (>= 1.21.8)
Imports: BiocGenerics, S4Vectors, IRanges, GenomeInfoDb
Suggests: BiocStyle, knitr, rmarkdown
VignetteBuilder: knitr
License: Artistic-2.0
Collate: SummarizedExperiment-class.R
SummarizedExperiment-rowRanges-methods.R
Expand Down
34 changes: 34 additions & 0 deletions vignettes/SummarizedExperiment.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: "_SummarizedExperiment_ for Coordinating Experimental Assays, Samples, and Regions of Interest"
author: "Martin Morgan"
date: "Revised: 14 May, 2015"
output:
BiocStyle::html_document:
toc: true
vignette: >
%\VignetteIndexEntry{SummarizedExperiment}
%\VignetteEngine{knitr::rmarkdown}
\usepackage[utf8]{inputenc}
---

```{r style, echo=FALSE, results='asis'}
BiocStyle::markdown()
```

# Motivating use case

# Parts of a _SummarizedExperiment_

## Assays

## 'Row' (regions-of-interest) data

### Genomic ranges or data frames?

## Experimental metadata

# Common operations on _SummarizedExperiment_

# Case study revisited -- _SummarizedExperiment_ in action

# Advanced: Extending _SummarizedExperiment_

0 comments on commit 4e76d04

Please sign in to comment.