refine.bio Examples Guide
This repository contains example workflows of how to use data downloaded from refine.bio.
How to use this repository
We recommend cloning this repository and following the example analyses. You can also use the green button that says "Clone or download" to "Download ZIP" and then use this repository as you please on your own computer, if you prefer.
Each directory in this repository is a set of example workflows to follow. See the list of Example Modules below for list of the analysis topics.
Each directory is a module of example workflow(s) and contains:
READMEthat introduces you to the concepts, requirements, and workflows for that module.
- Example dataset(s) in the
plotsfolder(s) that contains the output of the analyses.
- An R Notebook which consists of:
- An R markdown (
Rmd) file(s) that you can use in RStudio to run the analysis
nb.htmlfile that is the resulting output of the Rmd file rendered as an HTML file.
- An R markdown (
As you get more comfortable with the examples, we encourage you to apply these example workflows to your own refine.bio data.
After downloading a refine.bio dataset, you can analyze them in these examples by placing the gene expression and metadata TSV files from your refine.bio download file into the respective
data/ folder for that module.
You'll need to change any file names in the notebook to correspond to your own dataset.
You will likely have to alter other steps of the examples, particularly those cleaning or filtering based on metadata.
General requirements for the example workflows
Each module requires you to install the following software to run examples yourself.
- RStudio for working with R Notebooks.
will be required for installing some packages from GitHub. We recommend installing
These requirements can be installed by following the instructions at the links above. The example R Notebooks are designed to check if additional required packages are installed and will install them if they are not. Each example module directory will include further instructions for how to follow along with the examples.
Example modules in this repository
GenePattern modules with refine.bio data
GenePattern has many ready-made analyses you could use with your refine.bio data. Some example workflows (such as differential expression and clustering) also include instructions for prepping your refine.bio data files for use in GenePattern. For users who are not comfortable with using R Notebooks, the GenePattern modules can be run using a graphics user interface (GUI), so this may be more intuitive for you.