Difference between revisions of "Twitter Analysis DB GUI"

From OpenCircuits
Jump to navigation Jump to search
Line 39: Line 39:
  
 
== Selection ==
 
== Selection ==
 +
 +
Sets basic choices about your selection:
 +
 +
* Select Type: Dropdown choose between different selection types that focus on different tables in the database.  After a selection is chosen you can get more information about it using the <About It> button.  The information is
 +
displayed in the message area.
  
 
You can select between:
 
You can select between:
* Tweets cross referenced to the concordance
+
** Tweets cross referenced to the concordance
* Just information on the concordance
+
** Just information on the concordance
 +
 
 +
* <About It>: Shows information about the Select Type.  In addition to "static" information it also shows the SQL for the current choices in the GUI.  This is most useful to those of you who know a bit of SQL.  This SQL can also be copied from the message area and used in other SQL tools.
 +
 
 +
* Sort: Dropdown gives you a list of sort orders for your selection ( not all sort orders are valid for all reports, eventually the GUI may show only valid sort orders, but not yet.
  
Choose a sort order for example:
+
Types of sort orders include:
* sort by datetime of the tweet.
+
** sort by datetime of the tweet.
* sort alphabetically by the words in the concordance  
+
** sort alphabetically by the words in the concordance  
  
Output is available in several different formats:
+
* Output Format: Dropdown give several choices including:  
* simple text
+
** simple text file
* csv
+
** csv file
* html
+
** html
* msg -- this is a format with reduced content that comes right to the message area, in some cases in a fraction of a second.
+
** msg -- this is a format with reduced content that comes right to the message area, in some cases in a fraction of a second.
 
* ..... as needs and interests dictate.  Adding format is not a major task.  pdf might be considered.
 
* ..... as needs and interests dictate.  Adding format is not a major task.  pdf might be considered.
 +
 
The app attempts to open each output in the program on your system best for that file type.
 
The app attempts to open each output in the program on your system best for that file type.
 
  
 
== Select Values ==
 
== Select Values ==

Revision as of 05:21, 24 May 2020

Overview ( early version )

The GUI or graphical user interface is the key to using the Twitter Analysis DB. The main page for the project is Twitter Analysis DB - OpenCircuits . This page is the documentation for the GUI.

Screen Shot

This is what it looks like, details on each part below. Still working on it, current download of code should be related, but may look quite different.

Error creating thumbnail: Unable to save thumbnail to destination


What Does What: The Controls

Control is mostly through buttons, sometimes supplemented by text fields. Outside of the GUI there is also a parameter file which controls start up and item like database file name. The large rectangle at the bottom right, a text area, is where information messages are displayed. It is referred to as the message area. Buttons on its left help control the display in the message areas.

Working from top to bottom:

At the Top

  • <Window title> Program name and some additional info including version and mode.
  • <ID Color Band >The green ( perhaps absent or some other color ) band under the title is an optional component, its height and color is set in the parameter file. It is normally useful only you want the app to have some distinctive color.

Firs Button Row

  • <Edit Log> opens an editor on the system ( needs to be configured in parameter file self.ex_editor = <name of executable or link> ) to view the python logging file for the app.
  • <Edit Parms > opens an editor on the system to edit the parameters.py file. See <Edit Log>. .... need better explanation perhaps not here.This editor is use to view .txt and .csv output. Its proper configuration is important.
  • <Restart> Restarts the application ( usually fast ) using new values ( if any ) in the parameter file(s).
  • <Test> May not be present, for debugging, not generally useful or predictable, you would need to look through the code to see what it might be doing, press at your own risk.
  • <Help> Link to this documentation.
  • <About> Bit of information on the program, the usual sort of stuff.

Selection

Sets basic choices about your selection:

  • Select Type: Dropdown choose between different selection types that focus on different tables in the database. After a selection is chosen you can get more information about it using the <About It> button. The information is

displayed in the message area.

You can select between:

    • Tweets cross referenced to the concordance
    • Just information on the concordance
  • <About It>: Shows information about the Select Type. In addition to "static" information it also shows the SQL for the current choices in the GUI. This is most useful to those of you who know a bit of SQL. This SQL can also be copied from the message area and used in other SQL tools.
  • Sort: Dropdown gives you a list of sort orders for your selection ( not all sort orders are valid for all reports, eventually the GUI may show only valid sort orders, but not yet.

Types of sort orders include:

    • sort by datetime of the tweet.
    • sort alphabetically by the words in the concordance
  • Output Format: Dropdown give several choices including:
    • simple text file
    • csv file
    • html
    • msg -- this is a format with reduced content that comes right to the message area, in some cases in a fraction of a second.
  • ..... as needs and interests dictate. Adding format is not a major task. pdf might be considered.

The app attempts to open each output in the program on your system best for that file type.

Select Values

Pairs of labels and widgets for input. Used in selects. Not all values are used for all selects.

  • Date Criteria
    • Start date and time
    • End date and time
    • Some accessory controls let you quickly select for: .........
  • Other Criteria
    • Word Search: search for a given word in the concordance
    • Is Covid: search for tweets tagged as covid19 pandemic related
    • Max Rank: the highest rank ( see db explanation at TBD ) words in the concordance to be selected.
    • Min Count:
    • TweetType: select tweets, retweets or any

Select Action

Each button runs some selection on the database based on the Select Values in the area above. Prior to the execution of the selection you will be shown ( in the message area ) the help for the selection and the sql and data for the query. You can then cancel or continue. This ( with the cancel ) is a good way to get help on each selection.

  • Output Format: You can choose the output format of the selection:
    • html
    • csv
    • txt file
  • <Tweets> Selects tweets that fit criteria on the window. To see the criteria press the button then cancel.
  • <Concordance>> Selects a concordance that fits criteria on the window. To see the criteria press the button then cancel.

Message Area

  • <Column of Buttons and Text Panel> The Panel shows program activity and some other info ( like the sql used in a query ) the buttons act on this data in some way. You might be able type in the text panel, to no particular effect, perhaps could use this to make notes. Text is partly erased from time to time depending on settings in parameter file(s)


  • Other controls:
    • <Clear> Clears text panel.
    • <Copy Sel> Copies all selected text. Use the mouse to select text.
    • <Copy All> Copies all text selected or not.
    • <A Scroll> When checked text panel automatically scrolls to the most recent data, else not. This can help you read earlier material when still receiving new data.