0.1.4 • Published 3 years ago

rolling-classify-visualizer v0.1.4

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

Rolling Stylometry Explorer

banner

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 stylo R library by the Computational Stylistics Group. Take a look here for the Live-Demo and the full documentation.

License: MIT PRs Welcome

Authors: Jonas Osburg, Lilly Osburg

Key Features

  • 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

How to use

  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 here)

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

How it works

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.

How to Contribute

Just open a pull request :smile_cat:

How to Cite

In case you want to cite us (we would appreciate it!)

Credits & Acknowledgements

  • The Rolling Stylometry Explorer is designed as a helpful tool for interpreting results from the stylo R library by the Computational Stylistics Group
  • The ReadMe was inspired by the NSGIF ReadMe
  • Icons by Material Design
  • Thanks to our Beta-Tester Christoph Schmidt-Petri

Useful Links

  • Resources offered by the Computational Stylistcs Group 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 this blog post on Rolling Stylometry by Maciej Eder

License

License: MIT