README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, echo = FALSE}
knitr::opts_chunk$set(
    collapse = TRUE,
    comment = "#>",
    fig.path = "man/figures/"
)
```

# GiottoClass <img src="man/figures/logo.png" align="right" alt="" width="160" />

<!-- badges: start -->
![Version](https://img.shields.io/github/r-package/v/drieslab/GiottoClass)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![codecov](https://codecov.io/gh/drieslab/GiottoClass/branch/dev/graph/badge.svg)](https://app.codecov.io/gh/drieslab/GiottoClass?branch=dev)
[![R-CMD-check](https://github.com/drieslab/GiottoClass/actions/workflows/main_check.yml/badge.svg)](https://github.com/drieslab/GiottoClass/actions/workflows/main_check.yml)
[![GitHub issues](https://img.shields.io/github/issues/drieslab/Giotto)](https://github.com/drieslab/Giotto/issues)
[![GitHub pulls](https://img.shields.io/github/issues-pr/drieslab/GiottoClass)](https://github.com/drieslab/GiottoClass/pulls)
<!-- badges: end -->

This package contains the Giotto object and subobject class
definitions and frameworks. Functionalities relating to data ingestion, basic object
creation, data access within the Giotto object, and generics defined for the 
Giotto classes are all found here.

Applications of this framework and convenience functions for loading specific
technologies are found in the base Giotto package.

## Installation

You can install GiottoClass like:

``` r
library(devtools)
install_github('drieslab/GiottoClass')
```