-
Notifications
You must be signed in to change notification settings - Fork 7
/
README.Rmd
50 lines (33 loc) · 2.58 KB
/
README.Rmd
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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
set.seed(42)
```
# oolong <img src="man/figures/oolong_logo.png" align="right" width="120" />
<!-- badges: start -->
[](https://codecov.io/gh/gesistsa/oolong?branch=v0.5)
[](https://joss.theoj.org/papers/6e535564e7142d705f4f3d68b18dac62)
[](https://CRAN.R-project.org/package=oolong)
<!-- badges: end -->
<img src="man/figures/oolong_demo.gif" align="center" height="400" />
The goal of oolong ^[/ˈuːlʊŋ/ 烏龍, literally means "Dark Dragon", is a semi-oxidized tea from Asia. It is very popular in Taiwan, Japan and Hong Kong. In Cantonese and Taiwanese Mandarin, the same word can also mean "confused". It perfectly captures the spirit of human-in-the-loop validation. ] is to generate and administrate validation tests easily for typical automated content analysis tools such as topic models and dictionary-based tools.
Please refer to the [overview](https://gesistsa.github.io/oolong/articles/overview.html) for an introduction to this package. If you need to deploy the test online, please refer to the [Deployment Vignette](https://gesistsa.github.io/oolong/articles/deploy.html). If you use BTM, please refer to the [BTM Vignette](https://gesistsa.github.io/oolong/articles/btm.html).
## Citation
Please cite this package as:
Chan C-h. & Sältzer M., (2020). oolong: An R package for validating automated content analysis tools. Journal of Open Source Software, 5(55), 2461, [https://doi.org/10.21105/joss.02461](https://doi.org/10.21105/joss.02461)
For a BibTeX entry, use the output from `citation(package = "oolong")`.
## Contributing
Contributions in the form of feedback, comments, code, and bug report are welcome.
* Fork the source code, modify, and issue a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
* Issues, bug reports: [File a Github issue](https://github.com/chainsawriot/oolong).
## Code of Conduct
Please note that the oolong project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
---