snowballing.py

This module provides tools to analyze the snowballing and widgets to perform and curate the snowballing

Events

EventRunner

class EventRunner(navigator, info=None)

Bases: object

access_attr(attr)

execute(event)

op_and(event)

op_eq(event)

op_ge(event)

op_gt(event)

op_if(event)

op_le(event)

op_lt(event)

op_neq(event)

op_not(event)

op_or(event)

op_plus(event)

op_pyref(event)

op_reload(event)

op_update_info(event)

set_attr(attr, value)

Widgets

WebNavigator

class WebNavigator(form_values, nwork, info, citation_var=None, citation_file=None, backward=True, should_add=None)

Bases: object

show(clear=True)

RunWidget

class RunWidget

Bases: object

clear()

clear_click(b)

click(b)

set_code(code)

ReplaceCellWidget

class ReplaceCellWidget

Bases: object

clear()

set_code(code)

Converter

class Converter(mode=None)

Bases: object

Convert texts into other formats

Four modes are available:

• BibTeX

  • Converts bibtex to a json for inserting the reference

• Text

  • Removes line breaks and diacricts from text. Use it to copy text from pdf documents

• [N] author name place other year

  • Converts references in this format to a json for inserting the reference

  • Consider each space as a line break

  • The “other” field can be created using multiple (or 0) lines

    • It also can define the attribute names using ‘attr=value’

    • For example:

      [1]
      Pimentel, João Felipe and Braganholo, Vanessa and Murta, Leonardo and Freire, Juliana
      Tracking and analyzing the evolution of provenance from scripts
      IPAW
      pp=16--28
      Springer
      2016
      
      [2]
      ...
      

• Quoted

  • Surrounds text with quotation marks and add spaces to fit the citation

bibtex(change)

Produces a json based on a bibtex

browser()

Presents the widget

citation(change)

Produces a json based on the format [N] author name place other year

pdf(change)

Extracts citations from pdf

quoted(change)

Adds quotes to value. Use it for citation

select(change)

Selects new mode. Use previous output as input

select_mode(mode)

Selects new mode. Use previous output as input

set_variable(b)

Creates variable ‘article_list’ with resulting JSON

text(change)

Removes line breaks and diacricts

write(b)

Writes right column according to selected mode

ArticleNavigator

class ArticleNavigator(citation_var=None, citation_file=None, articles=None, backward=True, force_citation_file=True)

Bases: object

Navigate on article list for insertion

browser()

Widget visualization

clear()

Clear cell and output

erase_article_form()

Erases form fields

next_article(b=None)

Next article click event

previous_article(b=None)

Previous article click event

process(event)

set_articles(articles)

Set list of articles and restart slider

show(b=None, clear=True)

Generic display

show_article(article, nwork, info, should)

Display article

update_info(info, field, widget, value=None, default='')

Update info according to widget

valid_articles(articles, show=False)

Generate valid articles

BackwardSnowballing

class BackwardSnowballing(citation_var, citation_file=None, articles=None, force_citation_file=True)

Bases: snowballing.snowballing.ArticleNavigator

Navigate on article list for insertion with backward citation

ForwardSnowballing

class ForwardSnowballing(querier, citation_var, citation_file=None, debug=False, start=None, load=True)

Bases: object

Navigate on article list for insertion with forward citation

browser()

Presents widget

next_page(b)

Gets next page from scholar

previous_page(b)

Gets previous page from scholar

reload(b, show=True)

Reloads page

ScholarUpdate

class ScholarUpdate(querier, worklist, force=False, debug=False, index=0, rules=None)

Bases: object

Widget for curating database

browser()

Present widget

next_page(b)

Go to next page

previous_page(b)

Go to previous page

reload(b=None, show=True)

Reload

set_index()

Set page index

show(b=None)

Show comparison

SearchScholar

class SearchScholar(querier, debug=False)

Bases: object

Search Scholar and Navigate on article list for insertion

browser()

Presents widget

next_page(b)

Gets next page from scholar

previous_page(b)

Gets previous page from scholar

reload(b, show=True)

Reloads page

search(b)