# rolling-classify-visualizer

> ![banner](https://github.com/stylo-explorer/rolling-stylometry-explorer/raw/master/docs/header.png)

Latest version **0.1.4** (published 2021-09-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install rolling-classify-visualizer
pnpm add rolling-classify-visualizer
yarn add rolling-classify-visualizer
bun add rolling-classify-visualizer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2021-09-14 |
| First published | 2021-09-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 18 |
| Unpacked size | 12.4 MB |
| Known vulnerabilities | 0 (+21 in 4 direct dependencies) |
| Install scripts | no |
| Maintainers | jnugh |

## Links

- npm: https://www.npmjs.com/package/rolling-classify-visualizer
- Repository: https://github.com/stylo-explorer/rolling-stylometry-explorer
- Homepage: https://stylo-explorer.github.io/
- Issues: https://github.com/stylo-explorer/rolling-stylometry-explorer/issues
- npm.io page: https://npm.io/package/rolling-classify-visualizer

## Dependencies (18)

- [meow](https://npm.io/package/meow.md) ^7.1.1
- [rxjs](https://npm.io/package/rxjs.md) ^6.6.3
- [tslib](https://npm.io/package/tslib.md) ^2.0.3
- [zone.js](https://npm.io/package/zone.js.md) ~0.10.2
- [inquirer](https://npm.io/package/inquirer.md) ^7.3.3
- [@angular/cdk](https://npm.io/package/@angular/cdk.md) ^10.2.5
- [@angular/core](https://npm.io/package/@angular/core.md) ^10.0.14
- [@angular/forms](https://npm.io/package/@angular/forms.md) ^10.0.14
- [@angular/common](https://npm.io/package/@angular/common.md) ^10.0.14
- [@angular/router](https://npm.io/package/@angular/router.md) ^10.1.6
- [@angular/compiler](https://npm.io/package/@angular/compiler.md) ^10.0.14
- [@angular/elements](https://npm.io/package/@angular/elements.md) ^10.0.14
- [@angular/material](https://npm.io/package/@angular/material.md) ^10.2.5
- [@angular/animations](https://npm.io/package/@angular/animations.md) ^10.0.14
- [resize-observer-polyfill](https://npm.io/package/resize-observer-polyfill.md) ^1.5.1
- [@angular/platform-browser](https://npm.io/package/@angular/platform-browser.md) ^10.0.14
- [document-register-element](https://npm.io/package/document-register-element.md) ^1.7.2
- [@angular/platform-browser-dynamic](https://npm.io/package/@angular/platform-browser-dynamic.md) ^10.0.14

## Recent versions

- 0.1.4 (latest) — 2021-09-14
- 0.1.3 — 2021-09-14
- 0.1.2 — 2021-09-14
- 0.1.1 — 2021-09-14
- 0.1.0 — 2021-09-14

## README

# Rolling Stylometry Explorer

![banner](https://github.com/stylo-explorer/rolling-stylometry-explorer/raw/master/docs/header.png)

<p align="center">
<img src="https://github.com/stylo-explorer/rolling-stylometry-explorer/raw/master/docs/rolling_stylo.gif" width="600">
</p>

The Rolling Stylometry Explorer is a web application to visualize rolling.classify results in the analyzed text. It was developed as a tool for use with the <a href="https://github.com/computationalstylistics/stylo">stylo R library</a> by the <a href="https://computationalstylistics.github.io/">Computational Stylistics Group</a>.
Take a look <a href="https://stylo-explorer.github.io/">here for the Live-Demo and the full documentation</a>.

[![License: MIT](https://img.shields.io/badge/License-MIT-black.svg)](https://opensource.org/licenses/MIT) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-black.svg?style=flat-square)](http://makeapullrequest.com) <a href="https://doi.org/10.5281/zenodo.4438291"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.4438291.svg" alt="DOI"></a>

<img src="https://github.com/stylo-explorer/rolling-stylometry-explorer/raw/master/docs/baseline_supervised_user_circle_black_48dp.png" width="15"> **Authors**: Jonas Osburg, Lilly Osburg </img>

## <img src="https://github.com/stylo-explorer/rolling-stylometry-explorer/raw/master/docs/baseline_computer_black_48dp.png" width="20"> Key Features </img>

- Display your rolling.classify results directly in the text
- Switch easily between different analyses and MFW values
- Use the Tooltip Feature to see the probabilities for each author
- Use the Gradient Feature and have the security of the authorship attribution displayed directly in the text (still work in progress)
- Keep track of the configurations of the various analyses displayed in the Rolling Stylometry Explorer - transfer the configurations and have them displayed directly in the Explorer

## <img src="https://github.com/stylo-explorer/rolling-stylometry-explorer/raw/master/docs/baseline_format_list_numbered_black_48dp.png" width="20"> How to use </img>

1. Download the Rolling Stylometry Explorer
2. Prepare your corpus
3. Move the `create_json_rolling.classify` into the folder containing the corpus. Paste your rolling.classify configuration into the `create_json_rolling.classify` file and execute it. It will perform the rolling.classify analysis you configured and generate a `classification.json` file with the results.
4. Execute the `json-consolidate.tx` file. Add the file path to the classification.json file(s). Follow the further instructions in the shell to provide information about the configurations, the analyzed text and possible authors. `json-consolidate` will then generate a `output.json` file.
5. Move the generated `output.json` file to `~/rolling-classify-visualizer/src/assets`
6. Implement the Rolling Sylometry Explorer on your website (or try it out <a href="https://stylo-explorer.github.io/pages/try-it.html">here</a>)

If you want to integrate multiple analyses into the Rolling Stylometry Explorer, repeat steps 1-3 and then pass multiple file paths

<p align="center">
<img src="https://github.com/stylo-explorer/rolling-stylometry-explorer/raw/master/docs/demo2.gif" width="600">
</p>

## <img src="https://github.com/stylo-explorer/rolling-stylometry-explorer/raw/master/docs/baseline_search_black_48dp.png" width="20"> How it works </img>

Rolling.classify performs a windowing procedure and divides the text into short, overlapping sections. Rolling.classify then uses a machine learning algorithm to assign an author to each section. The Rolling Stylometry Explorer divides the text into the same sections as rolling.classify. The assignment made by rolling.classify is then made visible in the text by color highlighting. Each author is assigned a color. The most probable author for the corresponding text section is determined using the probabilities calculated by rolling.classify.

## <img src="https://github.com/stylo-explorer/rolling-stylometry-explorer/raw/master/docs/baseline_create_black_48dp.png" width="20"> How to Contribute </img>

Just open a pull request :smile_cat:

## <img src="https://github.com/stylo-explorer/rolling-stylometry-explorer/raw/master/docs/baseline_menu_book_black_48dp.png" width="20"> How to Cite </img>

In case you want to cite us (we would appreciate it!)
<a href="https://doi.org/10.5281/zenodo.4438291"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.4438291.svg" alt="DOI"></a>

## <img src="https://github.com/stylo-explorer/rolling-stylometry-explorer/raw/master/docs/baseline_article_black_48dp.png" width="20"> Credits & Acknowledgements </img>

- The Rolling Stylometry Explorer is designed as a helpful tool for interpreting results from <a href="https://github.com/computationalstylistics/stylo">the stylo R library</a> by the <a href="https://computationalstylistics.github.io/">Computational Stylistics Group</a>
- The ReadMe was inspired by the <a href="https://github.com/NSRare/NSGIF#readme">NSGIF ReadMe</a>
- Icons by <a href="https://material.io/resources/icons">Material Design</a>
- Thanks to our Beta-Tester <a href="https://www.philosophie.kit.edu/mitarbeiter_513.php">Christoph Schmidt-Petri</a>

## <img src="https://github.com/stylo-explorer/rolling-stylometry-explorer/raw/master/docs/baseline_mouse_black_48dp.png" width="20"> Useful Links </img>

- <a href="https://computationalstylistics.github.io/resources/">Resources offered by the Computational Stylistcs Group</a> to start first rolling.classify analyses and try out stylo R and the Rolling Stylometry Explorer
- If you want to work with rolling.classify you should have a look at <a href="https://computationalstylistics.github.io/blog/rolling_stylometry/">this blog post</a> on Rolling Stylometry by Maciej Eder

## <img src="https://github.com/stylo-explorer/rolling-stylometry-explorer/raw/master/docs/baseline_description_black_48dp.png" width="20"> License </img>

[![License: MIT](https://img.shields.io/badge/License-MIT-black.svg)](https://opensource.org/licenses/MIT)

---
_Source: https://npm.io/package/rolling-classify-visualizer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._