rdracor

R package which provides access to the DraCor API.

https://github.com/dracor-org/rdracor

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (17.3%) to scientific vocabulary

Last synced: 11 months ago · JSON representation

Repository

R package which provides access to the DraCor API.

Basic Info

Host: GitHub
Owner: dracor-org
License: gpl-3.0
Language: R
Default Branch: main
Size: 1.69 MB

Statistics

Stars: 34
Watchers: 3
Forks: 2
Open Issues: 0
Releases: 0

Created almost 7 years ago · Last pushed 11 months ago

Metadata Files

Readme Changelog License

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  message = FALSE,
  warning = FALSE,
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```
# rdracor 




**Authors:** Ivan Pozdniakov, Frank Fischer

**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.

Owner

Name: DraCor
Login: dracor-org
Kind: organization
Location: Europe

Website: https://dracor.org/
Repositories: 60
Profile: https://github.com/dracor-org

Drama Corpora Project

GitHub Events

Total

Watch event: 12
Push event: 1

Last Year

Watch event: 12
Push event: 1

Committers

Last synced: over 3 years ago

All Time

Total Commits: 148
Total Committers: 3
Avg Commits per committer: 49.333
Development Distribution Score (DDS): 0.088

Top Committers

Name	Email	Commits
Pozdniakov	b**r@y**u	135
ivan	i**n@M**l	9
lehkost	f**s@g**m	4

Committer Domains (Top 20 + Academic)

yandex.ru: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time

Total issues: 8
Total pull requests: 22
Average time to close issues: 8 months
Average time to close pull requests: 1 day
Total issue authors: 5
Total pull request authors: 3
Average comments per issue: 2.13
Average comments per pull request: 0.0
Merged pull requests: 22
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 1
Average time to close issues: N/A
Average time to close pull requests: less than a minute
Issue authors: 0
Pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pozdniakov (2)
silviaegt (2)
lehkost (2)
cmil (1)
KovaZo (1)

Pull Request Authors

Pozdniakov (24)
cmil (1)
lehkost (1)

Top Labels

Issue Labels

enhancement (2) bug (1)

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 124 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 5
Total maintainers: 1

cran.r-project.org: rdracor

Access to the 'DraCor' API

Homepage: https://github.com/dracor-org/rdracor
Documentation: http://cran.r-project.org/web/packages/rdracor/rdracor.pdf
License: GPL (≥ 3)
Latest release: 1.0.5
published 11 months ago

Versions: 5
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 124 Last month

Rankings

Stargazers count: 15.1%

Forks count: 21.9%

Dependent packages count: 29.8%

Average: 30.9%

Dependent repos count: 35.5%

Downloads: 52.5%

Maintainers (1)

bucherr@yandex.ru

Last synced: 11 months ago

Dependencies

DESCRIPTION cran

data.table >= 1.12.2 imports
httr >= 1.4.1 imports
igraph >= 1.2.4.1 imports
jsonlite >= 1.6 imports
methods * imports
utils * imports
xml2 >= 1.2.2 imports
covr * suggests
testthat >= 2.1.0 suggests

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

rdracor

Science Score: 26.0%

Repository

Basic Info

Statistics

Metadata Files

README.Rmd

Owner

GitHub Events

Total

Last Year

Committers

All Time

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

cran.r-project.org: rdracor

Rankings

Maintainers (1)

Dependencies