gatepoints/README.Rmd at master · wjawaid/gatepoints · 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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
---
title: "Select points by drawing a freehand gate"
author: "Wajid Jawaid"
email: "wj241@alumni.cam.ac.uk"
date: "`r Sys.Date()`"
output: github_document
---

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

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

[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/gatepoints)](https://cran.r-project.org/package=gatepoints) [![Rdoc](https://www.rdocumentation.org/badges/version/gatepoints)](https://www.rdocumentation.org/packages/gatepoints) [![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![CRAN mirror downloads](https://cranlogs.r-pkg.org/badges/gatepoints)](https://cran.r-project.org/package=gatepoints/)

# Installation

**gatepoints** can be installed from Github or through CRAN.

## Github

```{r, echo = TRUE, eval = FALSE}
library(devtools)
install_github("wjawaid/gatepoints")
```

## CRAN

The package can be downloaded from CRAN using:

```{r echo = TRUE, eval = FALSE}
install.packages("gatepoints")
```

# Usage example

**gatepoints** provides an easy to use function, **fhs** (freehand select) for gating or selecting points freehand on a plot. If using from RStudio please use X11 display for a better user experience. Take the simple plot below:

```{r simpleplot, fig.show = 'hold', fig.cap = 'Simple plot.', fig.width = 6, fig.height = 6, dev = "png"}
x <- data.frame(x=1:10, y=1:10, row.names = 1:10)
## If you are using RStudio do X11() first.
plot(x, pch = 16, col = "red")
```

```{r, echo=TRUE, eval = FALSE}
library(gatepoints)
selectedPoints <- fhs(x, mark = TRUE)
```

To select an arbitrarily complex region run the above commands and proceed as follows:

1. Mark region of your choice by **left clicking** around your region of interest.
2. Close polygon by **right clicking**. On the Windows platform click **stop** after right clicking.

```{r, echo = FALSE, eval = TRUE}
selectedPoints <- c("4", "5", "7")
```

```{r gatedplot, echo=FALSE, eval = TRUE, fig.show = 'hold', fig.cap = 'Selected points', fig.width = 6, fig.height = 6, dev = "png"}
plot(x, pch = 16, col = "red")
x <- rbind(c(6.099191, 8.274120),
           c(8.129107, 7.048649),
           c(8.526881, 5.859404),
           c(5.700760, 6.716428),
           c(5.605314, 5.953430),
           c(6.866882, 3.764390),
           c(3.313575, 3.344069),
           c(2.417270, 5.217868))
polygon(x[,1], x[,2])
points(c(4,5,7), c(4,5,7))
```

```{r, echo = FALSE, eval = TRUE}
x <- as.data.frame(x)
colnames(x) <- c("x", "y")
attr(selectedPoints, "gate") <- x
```

The points can be marked as defined by the user with additional parameters passed to the **points** function. The names of the points as given by the rownames of the data frame **x** will be returned in **selectedPoints**. Additionally the points selected for the gate will be returned as the **gate** attribute.

```{r, echo = TRUE, eval = TRUE}
selectedPoints
```