Skip to content

3.0

Jump to bottom
Nils Reiter edited this page May 3, 2019 · 12 revisions

This page collects general things that will be changed from 2.x to 3.0.

See https://github.com/orgs/quadrama/projects/12 for the project with individual todos.

The goal is to allow for the workflows depicted in this picture:

Map of functions and classes

Classes

In DramaAnalysis 3.x, data objects will have a DramaAnalysis-specific class. This allows a) more flexibility in re-using functions and b) more safety, because functions can check whether an argument has the class they expect.

Functions

Admin and housekeeping

  • setup()
  • qd.colors: QuaDramA colors
  • setCollectionDirectory(): This function initialises the paths to data files.
  • setDataDirectory(): This function initialises the paths to data files.
  • ensureSuffix(): Utility functions
  • postags: Provides lists of groups of pos tags for various word classes.
  • rjmw.0: Data sets
  • rksp.0: Data sets

Dictionary analysis

  • loadFields(): Load word lists from text files/URLs
  • dictionaryStatistics(): Apply word lists to dramatic texts
  • dictionaryStatisticsSingle(): Dictionary Use
  • filterByDictionary(): Filter frequency table by dictionary
  • base_dictionary: Base dictionary stored for testing and demo
  • enrichDictionary: Enrich a dictionary using word2vec and a large corpus

Legacy

Character analysis

  • configuration(): Character Configuration
  • figureStatistics(): Basic Character Statistics
  • figurematrix(): Stacked matrix
  • presence(): Active and Passive Presence

Legacy

Utterance analysis

  • utteranceStatistics(): Utterance Statistics

Sequence and process

  • hamming(): Measuring Personnel Exchange over Boundaries
  • personnelExchange(): Measuring Personnel Exchange over Boundaries
  • scenicDifference(): Measuring Personnel Exchange over Boundaries

Deprecated

  • dramaHead(): Extract section
  • dramaTail(): Extract section

Plotting

  • plotSpiderWebs(): Spider-Webs
  • plotUtterancePositions(): Utterance positions

Exporting and Generation

  • isolateFigureSpeech(): Isolates Figure Speech
  • report(): Report

Language analysis

  • frequencytable Word frequencies
  • tfidf TF-IDF
  • keyness Keywords

Data Loading

  • loadAllInstalledIds Installed texts
  • loadAnnotations Load annotations
  • loadCharacters Character data loading
  • loadMeta Load meta data
  • loadSegmentedText Text Loading
  • loadSet Load Collections
  • loadSets Load Collections
  • newCollection Create or Extend a Collection
  • installCollectionData Download and install collection data
  • installData Download preprocessed drama data

Legacy

  • correlationAnalysis Correlation analysis
  • rankFiguresByAppearance Rank figures by their 1st appearance
  • rankFiguresByDramatisPersonae Rank figures by the dramatis personae
  • regroup(): removed, it's actually much simpler
  • dictionaryStatisticsL(): Dictionary Use. Will be removed in 3.0.
  • filterMentioned Filtering Mentioned Figures
  • limitFigures Filtering figures
Clone this wiki locally