Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/softloud/datatheatre

A satirical text-based experience of the data industry
https://github.com/softloud/datatheatre

Last synced: about 2 months ago
JSON representation

A satirical text-based experience of the data industry

Awesome Lists containing this project

README 

        



readme



code{white-space: pre-wrap;}

span.smallcaps{font-variant: small-caps;}

div.columns{display: flex; gap: min(4vw, 1.5em);}

div.column{flex: auto; overflow-x: auto;}

div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}

ul.task-list{list-style: none;}

ul.task-list li input[type="checkbox"] {

  width: 0.8em;

  margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */ 

  vertical-align: middle;

}






Why I’m learning pygame



I’m interested in learning pygame to explore how I can use data science to answer this question:




How does the probability of individual game events affect game outcomes of interest?




I figure, in order to do this, I need a feeling for how game data is generated, the logic of the code that produces it. I actually see a lot of video game data at work, but we have a lot of exploratory and dev ops work before I will have time to work on models. This is a hobby project.


I’m more interested in data science than in becoming a game developer (I love my job), so a core component of my game is that it is simple in the ways that are not crucial to data analysis. For this reason, it’s a satirical text-based anti-venture into data theatre.



Some data science bits


Keeping things simple, suppose the player only ever has two choices, and that these two choices carry weights specific to the game event. There must also be win and loss conditions.



Data science questions to explore


    

  • What are the optimal probability mass functions for each game event that provide the given desired game outcome?
    • 

  • What are the optimal game outcomes for the given probability mass functions of the game events?
    • 




Design document


These notes suggest writing a design document as a first step.



Overview


The goal of the game is for Y-Corp to go IPO and all employees become millionaires overnight. As a data scientist, the player must help the company achieve their goal SAS goal of implementing new features, and removing bugs.



Story of the game


The player begins as a data scientist at Y-Corp, an unspecified SAS company. Although their job title and department change, their job, pressing buttons, remains the same. The player presses buttons to validate data, produce reports, and fix bugs.



Targeted audience


Me and my friends.



Expected results


Current goal is to produce a game that - prompts the player to start - welcomes the player and invites them to progress to onboarding - provides a quietly rage quit button - onboards the player by prompting them to press a button - provides the player with at least 2 prompts and outputs, with probabilistic outcomes, and text rendered for the outcome dependent on the outcome’s random sampling. - tracks how many bugs and other win/loss conditions in a dataframe and stores that dataframe in game-data/ output - end of game report for player



Evaluation


Use data science to check evaluate the effect of game event probabilities on win/loss outcomes.



Initial list of tasks


    

  • resonably sensible structure to game logic: extensible and ease of refactoring
    • 

  • get the scenarios (welcome, prompts and outcomes) to run
    • 

  • output text in a pretty-enough way
    • 




File structure


    

  • game.py is the game script
    • 

  • game_fns.py contains game functions
    • 

  • things-to-fiddle-with/ contains small .csvs and text files that are have ease of input
    • 

  • game-data/ contains computationally-generated data that should not be modified
    • 

  • game-text-png/ contains hack image pipeline output for text rendering
    

    • 

  • make_game_text.R is the hack image pipeline script
    • 

  • blackboard.py is a scratchpad
    • 

  • data-theatre.iynb is first thoughts on data analysis
    • 

  • text_wrap.py is where the text wrapping functions are being developed
    • 

  • ui_fns.py is currently there for a user interface, but may be restructured out
    • 




window.document.addEventListener("DOMContentLoaded", function (event) {

  const toggleBodyColorMode = (bsSheetEl) => {

    const mode = bsSheetEl.getAttribute("data-mode");

    const bodyEl = window.document.querySelector("body");

    if (mode === "dark") {

      bodyEl.classList.add("quarto-dark");

      bodyEl.classList.remove("quarto-light");

    } else {

      bodyEl.classList.add("quarto-light");

      bodyEl.classList.remove("quarto-dark");

    }

  }

  const toggleBodyColorPrimary = () => {

    const bsSheetEl = window.document.querySelector("link#quarto-bootstrap");

    if (bsSheetEl) {

      toggleBodyColorMode(bsSheetEl);

    }

  }

  toggleBodyColorPrimary();  

  const icon = "";

  const anchorJS = new window.AnchorJS();

  anchorJS.options = {

    placement: 'right',

    icon: icon

  };

  anchorJS.add('.anchored');

  const isCodeAnnotation = (el) => {

    for (const clz of el.classList) {

      if (clz.startsWith('code-annotation-')) {                     

        return true;

      }

    }

    return false;

  }

  const clipboard = new window.ClipboardJS('.code-copy-button', {

    text: function(trigger) {

      const codeEl = trigger.previousElementSibling.cloneNode(true);

      for (const childEl of codeEl.children) {

        if (isCodeAnnotation(childEl)) {

          childEl.remove();

        }

      }

      return codeEl.innerText;

    }

  });

  clipboard.on('success', function(e) {

    // button target

    const button = e.trigger;

    // don't keep focus

    button.blur();

    // flash "checked"

    button.classList.add('code-copy-button-checked');

    var currentTitle = button.getAttribute("title");

    button.setAttribute("title", "Copied!");

    let tooltip;

    if (window.bootstrap) {

      button.setAttribute("data-bs-toggle", "tooltip");

      button.setAttribute("data-bs-placement", "left");

      button.setAttribute("data-bs-title", "Copied!");

      tooltip = new bootstrap.Tooltip(button, 

        { trigger: "manual", 

          customClass: "code-copy-button-tooltip",

          offset: [0, -8]});

      tooltip.show();    

    }

    setTimeout(function() {

      if (tooltip) {

        tooltip.hide();

        button.removeAttribute("data-bs-title");

        button.removeAttribute("data-bs-toggle");

        button.removeAttribute("data-bs-placement");

      }

      button.setAttribute("title", currentTitle);

      button.classList.remove('code-copy-button-checked');

    }, 1000);

    // clear code selection

    e.clearSelection();

  });

  function tippyHover(el, contentFn) {

    const config = {

      allowHTML: true,

      content: contentFn,

      maxWidth: 500,

      delay: 100,

      arrow: false,

      appendTo: function(el) {

          return el.parentElement;

      },

      interactive: true,

      interactiveBorder: 10,

      theme: 'quarto',

      placement: 'bottom-start'

    };

    window.tippy(el, config); 

  }

  const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');

  for (var i=0; i<noterefs.length; i++) {

    const ref = noterefs[i];

    tippyHover(ref, function() {

      // use id or data attribute instead here

      let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');

      try { href = new URL(href).hash; } catch {}

      const id = href.replace(/^#\/?/, "");

      const note = window.document.getElementById(id);

      return note.innerHTML;

    });

  }

      let selectedAnnoteEl;

      const selectorForAnnotation = ( cell, annotation) => {

        let cellAttr = 'data-code-cell="' + cell + '"';

        let lineAttr = 'data-code-annotation="' +  annotation + '"';

        const selector = 'span[' + cellAttr + '][' + lineAttr + ']';

        return selector;

      }

      const selectCodeLines = (annoteEl) => {

        const doc = window.document;

        const targetCell = annoteEl.getAttribute("data-target-cell");

        const targetAnnotation = annoteEl.getAttribute("data-target-annotation");

        const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));

        const lines = annoteSpan.getAttribute("data-code-lines").split(",");

        const lineIds = lines.map((line) => {

          return targetCell + "-" + line;

        })

        let top = null;

        let height = null;

        let parent = null;

        if (lineIds.length > 0) {

            //compute the position of the single el (top and bottom and make a div)

            const el = window.document.getElementById(lineIds[0]);

            top = el.offsetTop;

            height = el.offsetHeight;

            parent = el.parentElement.parentElement;

          if (lineIds.length > 1) {

            const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);

            const bottom = lastEl.offsetTop + lastEl.offsetHeight;

            height = bottom - top;

          }

          if (top !== null && height !== null && parent !== null) {

            // cook up a div (if necessary) and position it 

            let div = window.document.getElementById("code-annotation-line-highlight");

            if (div === null) {

              div = window.document.createElement("div");

              div.setAttribute("id", "code-annotation-line-highlight");

              div.style.position = 'absolute';

              parent.appendChild(div);

            }

            div.style.top = top - 2 + "px";

            div.style.height = height + 4 + "px";

            let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");

            if (gutterDiv === null) {

              gutterDiv = window.document.createElement("div");

              gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");

              gutterDiv.style.position = 'absolute';

              const codeCell = window.document.getElementById(targetCell);

              const gutter = codeCell.querySelector('.code-annotation-gutter');

              gutter.appendChild(gutterDiv);

            }

            gutterDiv.style.top = top - 2 + "px";

            gutterDiv.style.height = height + 4 + "px";

          }

          selectedAnnoteEl = annoteEl;

        }

      };

      const unselectCodeLines = () => {

        const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];

        elementsIds.forEach((elId) => {

          const div = window.document.getElementById(elId);

          if (div) {

            div.remove();

          }

        });

        selectedAnnoteEl = undefined;

      };

      // Attach click handler to the DT

      const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');

      for (const annoteDlNode of annoteDls) {

        annoteDlNode.addEventListener('click', (event) => {

          const clickedEl = event.target;

          if (clickedEl !== selectedAnnoteEl) {

            unselectCodeLines();

            const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');

            if (activeEl) {

              activeEl.classList.remove('code-annotation-active');

            }

            selectCodeLines(clickedEl);

            clickedEl.classList.add('code-annotation-active');

          } else {

            // Unselect the line

            unselectCodeLines();

            clickedEl.classList.remove('code-annotation-active');

          }

        });

      }

  const findCites = (el) => {

    const parentEl = el.parentElement;

    if (parentEl) {

      const cites = parentEl.dataset.cites;

      if (cites) {

        return {

          el,

          cites: cites.split(' ')

        };

      } else {

        return findCites(el.parentElement)

      }

    } else {

      return undefined;

    }

  };

  var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');

  for (var i=0; i<bibliorefs.length; i++) {

    const ref = bibliorefs[i];

    const citeInfo = findCites(ref);

    if (citeInfo) {

      tippyHover(citeInfo.el, function() {

        var popup = window.document.createElement('div');

        citeInfo.cites.forEach(function(cite) {

          var citeDiv = window.document.createElement('div');

          citeDiv.classList.add('hanging-indent');

          citeDiv.classList.add('csl-entry');

          var biblioDiv = window.document.getElementById('ref-' + cite);

          if (biblioDiv) {

            citeDiv.innerHTML = biblioDiv.innerHTML;

          }

          popup.appendChild(citeDiv);

        });

        return popup.innerHTML;

      });

    }

  }

});