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%"
)
```

# microfunk

<!-- badges: start -->
[![GitHub issues](https://img.shields.io/github/issues/MicrobialGenomics-IrsicaixaOrg/microfunk)](https://github.com/MicrobialGenomics-IrsicaixaOrg/microfunk/issues)
[![GitHub pulls](https://img.shields.io/github/issues-pr/MicrobialGenomics-IrsicaixaOrg/microfunk)](https://github.com/MicrobialGenomics-IrsicaixaOrg/microfunk/pulls)
<!-- badges: end -->

The goal of `microfunk` is to ...

## Installation instructions

Get the latest stable `R` release from [CRAN](http://cran.r-project.org/). Then install `microfunk` from [Bioconductor](http://bioconductor.org/) using the following code:

```{r 'install', eval = FALSE}
if (!requireNamespace("BiocManager", quietly = TRUE)) {
    install.packages("BiocManager")
}

BiocManager::install("microfunk")
```

And the development version from [GitHub](https://github.com/juditfarreb/microfunk) with:

```{r 'install_dev', eval = FALSE}
BiocManager::install("juditfarreb/microfunk")
```
## Example

This is a basic example which shows you how to solve a common problem:

```{r example, eval = requireNamespace('microfunk')}
library("microfunk")
## basic example code
```

What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:

```{r cars}
summary(cars)
```

You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date.

You can also embed plots, for example:

```{r pressure, echo = FALSE}
plot(pressure)
```

In that case, don't forget to commit and push the resulting figure files, so they display on GitHub!

## Citation

Below is the citation output from using `citation('microfunk')` in R. Please
run this yourself to check for any updates on how to cite __microfunk__.

```{r 'citation', eval = requireNamespace('microfunk')}
print(citation('microfunk'), bibtex = TRUE)
```

Please note that the `microfunk` was only made possible thanks to many other R and bioinformatics software authors, which are cited either in the vignettes and/or the paper(s) describing this package.

## Code of Conduct

Please note that the `microfunk` project is released with a [Contributor Code of Conduct](http://bioconductor.org/about/code-of-conduct/). By contributing to this project, you agree to abide by its terms.

## Development tools