PANORAMA/README.Rmd at main · SchwartzLab/PANORAMA · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
---
output: github_document
editor_options:
  chunk_output_type: console
---

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

# PANORAMA <img src='man/figures/logo.png' align="right" height="150" /></a>


<!-- badges: start -->
`r badger::badge_devel("SchwartzLab/PANORAMA", "blue")`
<!-- badges: end -->

## Description

**PANORAMA** is a package that processes Pan-Mod-seq-based data, making use of
the [**txtools**](https://github.com/AngelCampos/txtools) package.

## Installation

You can install the development version from
[GitHub](https://github.com/SchwartzLab/PANORAMA) typing in the following
commands in the R console:

```{r, installation, eval = FALSE}
if (!requireNamespace("remotes", quietly = TRUE))
    install.packages("remotes")
remotes::install_github("SchwartzLab/PANORAMA", build_vignettes = FALSE)
```

If you want to build the vignette, please install with the following command
(only works while connected to WEXAC).

```{r, eval = FALSE}
if (!requireNamespace("remotes", quietly = TRUE))
    install.packages("remotes")
remotes::install_github("SchwartzLab/PANORAMA", build_vignettes = TRUE)
```

## Further documentation

To open the "Using PANORAMA at WEXAC" vignette run the following command.

```{r, eval = FALSE}
vignette("Using_PANORAMA_at_WEXAC", package = "PANORAMA")
```

## Current limitations

## Licence

PANORAMA is developed under the [Artistic Licence 2.0](https://opensource.org/licenses/Artistic-2.0).