---
title: "SingleMoleculeFootprintingData"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{SingleMoleculeFootprintingData}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```

```{r setup}
library(SingleMoleculeFootprintingData)
```

The data objects provided with SingleMoleculeFootprintingData can be downloaded and cached using the dedicated accessor functions. Here we exemplify how to access the index to the bam file containing example SMF sequencing data. 

```{r}
SingleMoleculeFootprintingData::NRF1pair.bam.bai()
```

N.b.: users of the SingleMoleculeFootprinting pkg do not need to manually download and cache SingleMoleculeFootprintingData objects since we perform this task under the hood in the vignette of SingleMoleculeFootprinting. This is to create the QuasR input file pointing at the example NRF1pair data necessary to run the vignette itself.
