orange-story-navigator

Add-on to the Orange3 data mining toolkit with text processing widgets from the project Navigating Stories

https://github.com/navigating-stories/orange-story-navigator

Science Score: 67.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.6%) to scientific vocabulary

Keywords

data-analysis orange3 stories storytelling text-mining
Last synced: 6 months ago · JSON representation ·

Repository

Add-on to the Orange3 data mining toolkit with text processing widgets from the project Navigating Stories

Basic Info
Statistics
  • Stars: 4
  • Watchers: 1
  • Forks: 1
  • Open Issues: 58
  • Releases: 40
Topics
data-analysis orange3 stories storytelling text-mining
Created over 3 years ago · Last pushed 9 months ago
Metadata Files
Readme License Citation

README.md

Unit tests PyPI version Read the Docs DOI

setting_icon

Orange3 Story Navigator

Orange3-Story-Navigator is an add-on for the Orange data mining software package. It provides quantitative textual story analysis features based on principles in narrative psychology. The aim of the Story Navigator is to support human analysis of stories represented in digital texts, with a focus on identifying and describing the following components of the narrative (see [1], [2] and [3] for definitions and theory):

  1. Setting
  2. Main agent
  3. Means
  4. Acts and events
  5. Purpose
  6. Breach

[1] Burke, K. (1969). The grammar of motives. Prentice Hall, New York. Originally published in 1945.

[2] M. Murray and A. Sools, P. Rohleder, A.C. Lyons (Eds.), Qualitative research in clinical and health psychology, Palgrave MacMillan, Houndmills Basingstoke (2015), pp. 133-154

[3] Andrade, S. B., & Andersen, D. (2020). Digital story grammar: a quantitative methodology for narrative analysis. International Journal of Social Research Methodology, 23(4), 405-421.

Installation

This section is for those who want to install the Story Navigator purely for analysing stories with no plan to develop or extend the add-on.

Method 1

Requirements:

  1. Orange3
  2. Orange3-text
  3. Orange3-network

Steps:

  1. First install Orange. Instructions are here
  2. Fire up Orange, navigate to the Orange add-on installer which is available in the Options -> Add-ons menu. Note: the add-on requires Orange3-text and Orange3-network so first install these libraries before installing storynavigator.
  3. Click on the Add more... button on the top right of the window
  4. Type in storynavigator in the textbox and click on the Add button
  5. Click on the OK button
  6. The storynavigator add-on should install and Orange may ask you to restart it to view the new add-ons. Click on the OK button to do so.

Method 2

Requirements: Python 3.9.12+

Step: pip install storynavigator

User documentation

Available here

Development

This section is for those who want to build the add-on from source and extend, customise, or fix bugs in it. Note: Mac M1 (Apple silicon) users may encounter problems with building storynavigator using certain Python 3.8.x or 3.9.x versions and / or actually building or running these specific Python versions at all on your Mac. If you encounter such issues, it is recommended to install Rosetta 2 and always run the terminal using Rosetta 2 (see how to do the latter here) for development tasks.

Requirements:

  1. A tool for checking out a Git repository
  2. Python 3.9.12+

Steps to build and test from source:

  1. Get a copy of the code

    git clone git@github.com:navigating-stories/orange-story-navigator.git

  2. Change into the orange-story-navigator/ directory

    cd orange-story-navigator

  3. Create and activate a new Python virtual environment using virtualenv

  4. Run the following command

    pip install -r requirements.txt

  5. If Step 4. completed with no errors, run this command

    pip install -e .

This command installs the widget and registers it with your Orange3 installation. If you encountered an error during Step 4, file an issue with the details and skip the remaining steps.

  1. Run orange-canvas or python -m Orange.canvas

The Orange3 application should shortly start up with a splash screen

Testing

Run tests with pytest.

For coverage:

```python coverage run -m pytest coverage report

or

coverage html ```

Collaborators

The Story Navigator is maintained by the Netherlands eScience Center in collaboration with the Faculty of Behavioural, Management and Social Sciences (BMS) at the University of Twente.

Owner

  • Name: Navigating Stories
  • Login: navigating-stories
  • Kind: organization
  • Location: Netherlands

Citation (CITATION.cff)

 YAML 1.2
---
authors:
  - given-names: Kody
    family-names: Moodley
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0000-0001-5666-1658'
  - given-names: Flavio
    family-names: Hafner
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0009-0000-5893-9000'
  - given-names: Malte
    family-names: Lüken
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0000-0001-7095-203X'
  - given-names: Erik
    family-names: Tjong Kim Sang
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0000-0002-8431-081X'
  - given-names: Stef
    family-names: Smeets
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0000-0001-5107-3531'
  - given-names: Thijs
    family-names: Vroegh
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0000-0002-6311-0798'
cff-version: "1.2.0"
date-released: 2024-07-09
abstract: add-on for the Orange3 data mining platform which is able to analyse Dutch textual stories
          using the lenses of narrative psychology, narrative analysis, and narrative theory
keywords:
  - stories
  - text mining
  - storytelling
  - data analysis
  - orange3
identifiers:
  - type: doi
    value: 10.5281/zenodo.1310751
license: GPL-3.0
message: "If you use this software, please cite it using these metadata."
repository-code: "https://github.com/navigating-stories"
url: "https://orange-story-navigator.readthedocs.io/en/latest/"
title: "Navigating Stories"
version: "0.2.1"

GitHub Events

Total
  • Create event: 17
  • Release event: 6
  • Issues event: 30
  • Watch event: 2
  • Delete event: 12
  • Issue comment event: 7
  • Push event: 74
  • Pull request review comment event: 4
  • Pull request review event: 12
  • Pull request event: 15
Last Year
  • Create event: 17
  • Release event: 6
  • Issues event: 30
  • Watch event: 2
  • Delete event: 12
  • Issue comment event: 7
  • Push event: 74
  • Pull request review comment event: 4
  • Pull request review event: 12
  • Pull request event: 15

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: about 2 months
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.4
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: about 2 months
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.4
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • ThijsVroegh (29)
  • kodymoodley (14)
  • sgobyn (12)
  • f-hafner (11)
  • eriktks (8)
  • stefsmeets (3)
Pull Request Authors
  • ThijsVroegh (16)
  • eriktks (11)
  • kodymoodley (11)
  • f-hafner (7)
  • stefsmeets (4)
  • ankitkarki007 (1)
Top Labels
Issue Labels
bug (16) enhancement (13) discussed with saartje (9) workshop-april (6) under review (5) documentation (3) duplicate (1) priority (1)
Pull Request Labels
enhancement (3) documentation (2) discussed with saartje (1)

Dependencies

requirements.txt pypi
  • Orange3 *
  • Orange3-Text *
  • Orange3-network *
  • PyQt6 *
  • PyQtWebEngine *
  • dhtmlparser3 *
  • pandas *
  • recommonmark *
  • spacy *
  • sphinx *
  • sphinx-rtd-theme *
  • textblob *
pyproject.toml pypi
.github/workflows/publish-to-pypi.yml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/publish-to-testpypi.yml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite