---
title: "healthyControlsPresenceChecker vignette"
author: "Davide Chicco"
email: davide.chicco@gmail.com
date: "`r Sys.Date()`"
package: healthyControlsPresenceChecker
abstract: >
  healthyControlsPresenceChecker allows users to verify if a specific GEO dataset contains data of healthy controls amongside data of patients. 
output: 
  BiocStyle::html_document
vignette: >
  %\VignetteIndexEntry{healthyControlsPresenceChecker vignette}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}  
---

```{r style, echo = FALSE, results = 'asis'}
  BiocStyle::markdown()
```

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

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


## Introduction

Bioinformatics projects regarding the analysis of data of patients with cancer or other diseases often require the comparison between the results obtained on patients' data and results obtained on healthy controls' data. This step, although crucial, often cannot be performed if the dataset contains no healthy control data.
Looking for datasets containing both these kinds of the data can be tedious, and checking a specific dataset can be time-consuming, too.
Here we propose a software package that can immedaitely inform the user if data of healthy controls are present or not in a specific dataset.

## Description

healthyControlsPresenceChecker allows users to verify if a specific GEO dataset contains data of healthy controls amongside data of patients. 
 
## Installation via Bioconductor

Once this package will be available on Bioconductor, it will be possibile to install it through the following commands.

Start R (version "4.1") and enter:

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

BiocManager::install("healthyControlsPresenceChecker")
```

It will be possible to load the package with the following command:

```{r eval=FALSE}
library("healthyControlsPresenceChecker")
```

## Usage

The usage of healthyControlsPresenceChecker is very easy. The main function `healthyControlsCheck()` reads two input arguments: the GEO accession code of the dataset for which the user wants to verify the presence of the healthy controls, and a verbose flag.
For example, if the user wants to know if the [GSE47407](https://www.ncbi.nlm.nih.gov/geo/query/acc.cgi?acc=GSE47407) dataset contains data of healthy controls, she/he can type on a terminal shell within the R environment:


```{r, eval=TRUE}
outcomeGSE47407 <- healthyControlsCheck("GSE47407", TRUE)
```

The function will print all the intermediate messages, and eventually the `outcomeGSE47407` variable will be true if healthy controls were found, or false otherwise.

## Contacts

This software was developed by [Davide Chicco](https://www.DavideChicco.it), who can be contacted via email at davidechicco(AT)davidechicco.it

 Session Info

```{r, tidy=TRUE}
sessionInfo()
```