README.Rmd

---
output: github_document
---

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

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```
# ImmuneDR: A Community Curated Immune Resource Database in R Format

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental) ![GitHub repo size](https://img.shields.io/github/repo-size/ShixiangWang/ImmuneDR) [![GitHub license](https://img.shields.io/github/license/ShixiangWang/ImmuneDR)](https://github.com/ShixiangWang/ImmuneDR) [![GitHub stars](https://img.shields.io/github/stars/ShixiangWang/ImmuneDR)](https://github.com/ShixiangWang/ImmuneDR/stargazers) [![GitHub issues](https://img.shields.io/github/issues/ShixiangWang/ImmuneDR)](https://github.com/ShixiangWang/ImmuneDR/issues) 
<!-- badges: end -->

## Purpose

Better science is open science and shared science.
As a researcher in cancer immunomics, I always spend much time in data cleaning in my every project.
However, there are a limited number of datasets available for analysis. Most of 
them are very small with only a few patients/samples, especially for immunotherapy datasets.
This causing many works cannot be reproduced or have limited power. Therefore, I
create this community mantained project named **ImmuneDR** to host a curated immune resource database in r format.

I think a curated database can speed up progress of researches in all immune related projects
and thus cancer patients have opportunities to earlier benefit from our works.
I hope all researchers studying cancer/immunology can search, collect and submit published data to
this project and help maintain them.

All data will be stored in GitHub (when less than 1GB) and access methods are provided to everyone for free.

Thanks.

-- *Shixiang*

## Submission

TODO: create an issue template for submission.

## Usage

TODO: create the first database for immune cell infiltration and treat it as an example to show how to
store data and use them.

### Database design

### API

## LICENSE

The software is made available for non commercial research purposes only under the [GNU General Public License](LICENSE.md).
However, notwithstanding any provision of the GNU General Public License, the software currently may not be used for commercial purposes
without explicit written permission after contacting Shixiang Wang <wangshx@shanghaitech.edu.cn>.