forked from dracor-org/rdracor
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
180 lines (125 loc) · 3.82 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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
message = FALSE,
warning = FALSE,
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# rdracor <img src="man/figures/logo.png" align="right" width="120" />
<!-- badges: start -->
<!-- badges: end -->
**Authors:** Ivan Pozdniakov, Frank Fischer<br />
**License:** GPL-3
The goal of **rdracor** is to provide an R interface for the [DraCor API](https://dracor.org/documentation/api) (DraCor: Drama Corpora Project). Website of the project: [dracor.org](https://dracor.org).
## Installation
Installation from CRAN:
``` r
install.packages("rdracor")
```
If you wish to install the current build of the next release you can do so using the following:
```
# install.packages("remotes")
remotes::install_github("dracor-org/rdracor")
```
```{r example}
library(rdracor)
```
## Select DraCor API
DraCor API has several versions. By default, it utilizes the main branch:
```{r}
get_dracor_api_url()
```
You can set DraCor URL API of your choice:
```{r, eval = FALSE}
set_dracor_api_url("https://staging.dracor.org/api/v1")
```
## General info on corpora
Retrieving general information about available corpora:
```{r}
corpora <- get_dracor_meta()
summary(corpora)
plot(corpora)
```
## Plays in the corpus
```{r}
ger <- get_dracor(corpus = "ger")
summary(ger)
```
You can get all corpora at once:
```{r}
all <- get_dracor()
summary(all)
```
## Play metadata
With `get_play_metadata()` you can get miscellaneous data for a play:
```{r}
get_play_metadata(play = "lessing-emilia-galotti",
corpus = "ger",
full_metadata = FALSE) #use full_metadata = FALSE for faster download
```
## Play network
You can extract a co-occurence network (undirected weighted graph) for a
specific play:
```{r}
emilia <- get_net_cooccur_igraph(play = "lessing-emilia-galotti", corpus = "ger")
plot(emilia)
```
You can use the package `{igraph}` to work with this object as a graph:
```{r}
library(igraph)
edge_density(emilia)
cohesion(emilia)
```
In addition, you can get a summary with network properties and gender
distribution:
```{r}
summary(emilia)
```
Similarly, you can use function `get_net_relations_igraph()` to build a network
based on relationships data:
```{r}
galotti_relations <- get_net_relations_igraph(play = "lessing-emilia-galotti",
corpus = "ger")
plot(galotti_relations)
summary(galotti_relations)
```
## Text of a play
You can get text of a play in different forms:
- as a raw TEI (optionally parsed with `{xml2}`):
```{r}
get_text_tei(play = "lessing-emilia-galotti", corpus = "ger")
```
- as a character vector:
```{r}
text_galotti <- get_text_chr_spoken(play = "lessing-emilia-galotti",
corpus = "ger")
head(text_galotti)
```
- as a data frame:
```{r}
get_text_df(play = "lessing-emilia-galotti", corpus = "ger")
```
## Changing DraCor API
If you want to use another version of DraCor API (e.g. staging or locally saved on your computer), you can use function `set_dracor_api_url()`:
```{r}
set_dracor_api_url("https://staging.dracor.org/api/v1")
get_dracor("u")
```
Information on the working API can be retrieved by `dracor_api_info()`:
```{r}
dracor_api_info()
```
## Acknowledgments
The development of this research software was supported by Computational
Literary Studies Infrastructure (CLS INFRA) through its Transnational Access
Fellowship programme. CLS INFRA has received funding from the European Union’s
Horizon 2020 research and innovation programme under grant agreement №101004984.
<img src="man/figures/CLS.png" align="left" width="360" />
<img src="man/figures/Flag_of_Europe.png" align="left" width="360" />