-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
107 lines (69 loc) · 4.96 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
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
---
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%"
)
```
# ovva
<!-- badges: start -->
[](https://www.tidyverse.org/lifecycle/#maturing)
[](https://github.com/openvolley/ovva/actions/workflows/R-CMD-check.yaml)
[](https://codecov.io/gh/openvolley/ovva?branch=master)
<!-- badges: end -->
## About
This R package provides a Shiny app for viewing volleyball match videos in conjunction with scout files.
## Live demo
Try it for yourself: https://openvolley.shinyapps.io/ovva_demo/
(This demo is running on a free (time-limited) shinyapps tier, so it may not be available if too many people have used it recently.)
## Installation
```{r eval=FALSE}
options(repos = c(openvolley = "https://openvolley.r-universe.dev",
CRAN = "https://cloud.r-project.org"))
install.packages("ovva")
## or
## install.packages("remotes") ## if needed
remotes::install_github("openvolley/ovva")
```
## Usage
Try the inbuilt demo:
```{r eval = FALSE}
library(ovva)
ovva_shiny_demo()
```
Or start the shiny app with the path to your DataVolley files:
```{r eval = FALSE}
ovva_shiny(data_path = c(PL2018 = "data/volley/PlusLiga-2018_19"))
```
---
---
### Notes
1. In order for the app to find the video file associated with each dvw file, the video file path must be present in the dvw file. You can check this by inspecting the dvw file in a text editor --- you should see something like:
```
[3RESERVE]
[3VIDEO]
Camera0=D:\video\2019_03_01-KATS-BEDS.mp4
[3SCOUT]
```
2. If your videos are hosted online, you don't need them locally. This includes YouTube videos (they must be either 'public' or 'unlisted', but not 'private'). To use an online video, enter the URL as the video location:
```
[3RESERVE]
[3VIDEO]
Camera0=https://www.youtube.com/watch?v=NisDpPFPQwU
[3SCOUT]
```
and start `ovva` with `video_server = "none"`:
```{r eval = FALSE}
ovva_shiny(data_path = c(MyData = "my/dvw/path"), video_server = "none")
```
(note that with remote video files you still need your dvw files locally --- this is the `data_path` folder above).
3. The video server runs in a separate thread to the shiny application itself. If the `lighttpd` executable is present on the system path, this will be used for serving videos by default, otherwise the `servr` R package will be used. The performance of `lighttpd` is better, so you might want to install this if you don't already have it. On Windows, you can use `ovva_install_lighttpd()` to do this. On other platforms, you'll have to do it yourself. See https://www.lighttpd.net/download/.
---
Interested in this but you aren't an R user, or you want to be able to easily share this functionality with your players or coaches? See [this hosted version](https://apps.untan.gl/ovva/) (available by subscription).