-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
127 lines (96 loc) · 5.85 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
---
output:
github_document:
toc: true
---
<!-- 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%"
)
```
# Hermione
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
<!-- badges: end -->
The HERMIONE shiny dashboard, developed as part of the Social Inequality Observatory of the MUHAI project, allows you to interactively filter and explore co-occurrence entity networks, fine-grained narratives analysis, and case studies on inequality perception using online data from Twitter, collected in MUHAI's Observatory Knowledge Graph.
With HERMIONE you can: (i) Gain insights into how specific forms of inequality are perceived, and understood across time and contexts. (ii) Understand reactions and dialectical challenges to inequality by individuals, institutions, and organizations. (iii) Access powerful methods for retrieving, filtering, aggregating, and analyzing online debates about inequality from different perspectives.
## Installation
You can install the development version of Hermione from GitHub (main branch) as follows:
1. Install R (Version 4.2.2 or later) from here [https://cran.r-project.org/bin/](https://cran.r-project.org/bin/)
2. Install R dependencies
```
R -e 'install.packages("remotes")'
Rscript -e 'remotes::install_version("httr",upgrade="never", version = "1.4.5")'
Rscript -e 'remotes::install_version("bslib",upgrade="never", version = "0.4.2")'
Rscript -e 'remotes::install_version("rmarkdown",upgrade="never", version = "2.20")'
Rscript -e 'remotes::install_version("knitr",upgrade="never", version = "1.41")'
Rscript -e 'remotes::install_version("promises",upgrade="never", version = "1.2.0.1")'
Rscript -e 'remotes::install_version("shiny",upgrade="never", version = "1.7.4")'
Rscript -e 'remotes::install_version("ggplot2",upgrade="never", version = "3.4.0")'
Rscript -e 'remotes::install_version("config",upgrade="never", version = "0.3.1")'
Rscript -e 'remotes::install_version("waiter",upgrade="never", version = "0.2.5")'
Rscript -e 'remotes::install_version("fresh",upgrade="never", version = "0.2.0")'
Rscript -e 'remotes::install_version("testthat",upgrade="never", version = "3.1.6")'
Rscript -e 'remotes::install_version("spelling",upgrade="never", version = "2.2.1")'
Rscript -e 'remotes::install_version("shiny.semantic",upgrade="never", version = "0.4.3")'
Rscript -e 'remotes::install_version("tidytext",upgrade="never", version = "0.4.1")'
Rscript -e 'remotes::install_version("visNetwork",upgrade="never", version = "2.1.2")'
Rscript -e 'remotes::install_version("ipc",upgrade="never", version = "0.1.4")'
Rscript -e 'remotes::install_version("tidyverse",upgrade="never", version = "1.3.2")'
Rscript -e 'remotes::install_version("DT",upgrade="never", version = "0.27")'
Rscript -e 'remotes::install_version("echarts4r",upgrade="never", version = "0.4.5")'
Rscript -e 'remotes::install_version("shinyjs",upgrade="never", version = "2.1.0")'
Rscript -e 'remotes::install_version("shinyWidgets",upgrade="never", version = "0.7.6")'
Rscript -e 'remotes::install_version("future",upgrade="never", version = "1.30.0")'
Rscript -e 'remotes::install_version("golem",upgrade="never", version = "0.3.5")'
Rscript -e 'remotes::install_version("bs4Dash",upgrade="never", version = "2.2.1")'
Rscript -e 'remotes::install_version("quanteda",upgrade="never", version = "3.2.4")'
Rscript -e 'remotes::install_version("quanteda.textplots",upgrade="never", version = "0.94.2")'
Rscript -e 'remotes::install_version("fmsb",upgrade="never", version = "0.7.5")'
Rscript -e 'remotes::install_github("lgnbhl/textyle@8bb208e52dcc6e364b6f903283c319f67d9980be")'
```
3. Install HERMIONE package
```{r, eval = FALSE}
library(remotes)
remotes::install_github("carlosantagiustina/HERMIONE")
```
The app requires a token to access the backend (Observatory Knwledge Graph).
You can request a token writing an email to [[email protected]](mailto:[email protected]).
The app searches for a .txt file containing the token at the following path:
/Users/[your-username]/HERMIONE_KEY.txt
which is equivalent to the output of the R code:
```{r, eval = FALSE}
paste0(Sys.getenv("HOME"),"/HERMIONE_KEY.txt")
```
## Dockerized version of HERMIONE app
Hermione is also available in a dockerized version.
To build the docker container please use the following command from the main folder of the project using your terminal/bash/console:
```
docker build . -t hermione
docker run -p 127.0.0.1:8080:80 hermione
```
## How to run the Hermione dashboard
This is a basic example which shows you how to solve a common problem:
```{r, eval = FALSE}
#Load Hermione library
library(Hermione)
#run Hermione app
Hermione::run_app()
#Enjoy!
```
# References
```{=latex}
\begin{itemize}
\item Spillner, L., Santagiustina, C. R. M. A., Mildner, T., & Porzel, R. (2023). Mapping and Exploring the Dynamics of Inequality Narratives Through Social Media.
\item Spillner, L., Santagiustina, C. R., Mildner, T., & Porzel, R. (2022). Towards conflictual narrative mechanics. In Proceedings of the IJCAI/ECAI Workshop on Semantic Techniques for Narrative-based Understanding.
\end{itemize}
```
# HERMIONE dev team
- (creator & maintainer) Carlo R. M. A. Santagiustina [[email protected]](mailto:[email protected])
- (contributor) Laura Spillner [[email protected]](mailto:[email protected])
Hermoine queries and consumes in real time data from MUHAI's Observatory Knowledge Graph. Source code and more information about the OKG is available at this link:
[https://github.com/muhai-project/okg_media_discourse](https://github.com/muhai-project/okg_media_discourse)