Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/srkobakian/taipan
Image Annotations in R
https://github.com/srkobakian/taipan
Last synced: 3 months ago
JSON representation
Image Annotations in R
- Host: GitHub
- URL: https://github.com/srkobakian/taipan
- Owner: srkobakian
- License: gpl-3.0
- Created: 2017-09-05T04:47:33.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-30T03:51:35.000Z (about 5 years ago)
- Last Synced: 2024-05-21T02:12:20.018Z (6 months ago)
- Language: R
- Homepage: https://srkobakian.github.io/taipan/
- Size: 30.9 MB
- Stars: 33
- Watchers: 4
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE.md
Awesome Lists containing this project
README
---
output: github_document
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# Taipan 
[](https://travis-ci.org/srkobakian/taipan)
[](https://cran.r-project.org/package=taipan)
[](https://cran.r-project.org/package=taipan)
Taipan is a Tool for Annotating Images in Preparation for ANalysis.
The Taipan package creates simple shiny surveys. The web applications can be used locally or deployed and allow people to save survey results as tidy data that is ready to use for analysis.
The app was initially created to streamline the process of manually tagging images to create a training set.
It allows users to provide information regarding entire images, and smaller regions within. It is a survey style tool, with questions being posed for each image and area identified.
## Installation
You can install the **stable** version from [CRAN](https://cran.r-project.org/package=taipan).
```{r, eval = FALSE}
install.packages('taipan')
```
You can install the development version from Github using:
```{r, eval = FALSE}
# install.packages("devtools")
devtools::install_github("srkobakian/taipan")
```
## Usage
Taipan builds a shiny app suitable for annotating images. Questions can be provided for two scenarios in the app: 'scene' and 'selection'. Scene questions are suitable for questions that apply to the whole image, and are shown when no selection is made. Selection questions are appropriate for selected areas of the image, and are shown when a selection is made.
These lists of questions can be flexibly produced using the `taipanQuestions` function, where any shiny inputs and web elements can be used to build your own survey UI. For example, to train a model for identifying hotdogs and condiments, you could use this interface:
```{r, eval = FALSE}
library(taipan)
library(shiny)
questions <- taipanQuestions(
scene = sliderInput("quality", label = "Image Quality",
min = 0, max = 10, value = 5),
selection = div(
radioButtons("hotdog", label = "Hotdog?",
choices = list("Hotdog", "Not hotdog")),
checkboxGroupInput("extra", label = "Condiments",
choices = list("Onion", "Tomato (Ketchup)", "Barbeque", "Mustard"))
)
)
```
To build a taipan app with these questions, we can use the `buildTaipan` function and provide a set of images to annotate. These images can be provided locally, or via links to the web. You can specify where the app will be created with the `appdir` argument.
```{r, eval = FALSE}
buildTaipan(
questions = questions,
images = c("https://raw.githubusercontent.com/srkobakian/taipan/master/sample_images/hotdog.jpg",
"https://raw.githubusercontent.com/srkobakian/taipan/master/sample_images/not_hotdog.jpg"),
appdir = file.path(tempdir(), "taipan"), overwrite = TRUE
)
```
