README.Rmd

---
output: github_document
---

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

<img src="man/figures/logo.svg" align="right" alt="" width="120" />

<!-- badges: start -->
[![pages-build-deployment](https://github.com/jinghuazhao/pQTLtools/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/jinghuazhao/pQTLtools/actions/workflows/pages/pages-build-deployment)
[![R-CMD-check](https://github.com/jinghuazhao/pQTLtools/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jinghuazhao/pQTLtools/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

## A protein Quantitative Trait Locus toolkit

```{r, echo = FALSE, message=FALSE, warning=FALSE}
desc <- read.dcf("DESCRIPTION")
description <- desc[, "Description"]
lines <- unlist(lapply(strsplit(description, "\n"),paste,""))
lines[[length(lines)]] <- gsub(" $","",lines[[length(lines)]])
knitr::asis_output(lines)
```

## Installation

The latest version of pQTLtools can be installed as usual:

### 1. Install from R

```r
if (!requireNamespace("remotes", quietly = TRUE)) install.packages("remotes")
remotes::install_github("jinghuazhao/pQTLtools")
```

### 2. Install from GitHub repository

```bash
git clone https://github.com/jinghuazhao/pQTLtools
R CMD INSTALL pQTLtools
```

Dependencies are detailed in the DECRIPTION file of the package at GitHub.

## A summary of functions

This can be seen from R with

```r
library(help=pQTLtools)
```

or

```r
library(pQTLtools)
?pQTLtools
```