Analytics/Wikimetrics/Stories

-- DONE --
These stories have been implemented and are live on https://metrics.wmflabs.org/

-- HIGHEST PRIORITY -
Stories below are up next to implement. Scheduled stories will be added to the latest sprint at http://sb.wmflabs.org/t/analytics-developers/.

User creates cohort with CentralAuth insertions

 * Story
 * As a Wikimetrics user, I want to create a new cohort that is expanded to include wiki users on every wiki they have been active on, so that I can then create reports that include activity across wikis.
 * Event occurs after user clicks "Upload a new cohort" on the "My cohorts" page, they then have an option (checkbox) to expand the cohort
 * Activity on other wikis is given by CentralAuth
 * Bug ID 66843
 * Commitment to develop in sprint: http://sb.wmflabs.org/t/analytics-developers/2014-10-16/
 * If a wiki user in a cohort logs into a previously unvisited wiki after the cohort was created, the cohort will not be updated dynamically to include this wiki user on this newly visited wiki.


 * UX
 * Option is presented only when user is about to upload a new cohort
 * checkbox text is: "Expand cohort to all user’s accounts across projects (via CentralAuth)"

-- NEXT TO SPEC OUT --
Stories below are the next high priority to be discussed and defined.

Deleting a username from a cohort

 * Story: User browses a list of usernames in a cohort, and deletes one or more usernames from that cohort by checking a checkbox next to each name and clicking "delete".

Notes
 * Status: Some development work has been done on this; UI has been proposed, need input from Grantmaking. Then can be submitted as a patch for review to Analytics dev.
 * Possible issues: with centralauth, you may see multiples. That could be cumbersome. Suggest collapsing to a single username, to make it easier/quicker to delete.
 * ''See also ,

Tag your own cohort with existing tags

 * Story: User clicks "add tag" input on the page for one of their own cohorts and a list appears with existing tags, typing filters list to existing tag list (like google).

Notes
 * See also Analytics/Wikimetrics/Adding_New_Features/Tag_Cohorts

Deleting a username from a cohort

 * Story: User browses a list of usernames in a cohort, and deletes one or more usernames from that cohort by checking a checkbox next to each name and clicking "delete".

Notes
 * Status: Some development work has been done on this; UI has been proposed, need input from Grantmaking. Then can be submitted as a patch for review to Analytics dev.
 * Possible issues: with centralauth, you may see multiples. That could be cumbersome. Suggest collapsing to a single username, to make it easier/quicker to delete.
 * ''See also ,

List usernames in reports that include individual results

 * Story: When a user download date from a report that contains individual results in CSV or JSON, the file contains both user names and user ids


 * Notes
 * currently, these data files only contain user ids, even if the cohort was created with user names

View your tagged cohorts

 * Story #1: User clicks on a tag on the page for one of their own cohorts to display all of their cohorts with that tag.


 * Story #2: User clicks on a tag in a list of all tags to display all of their cohorts with that tag.

Notes
 * need a UI for page that displays lists of all cohorts with a given tag, list of all tags
 * for all tags page, need to visually separate system-defined vs. user-defined tags

Wikimetrics admin reporting

 * Story: Grantmaking staffer gets weekly CSV dump of data on all existing cohorts and reports up to that point

Notes
 * for each cohort, dump should contain metadata like creation date, cohort creator, tags on the cohort
 * for each report, dump should contain metadata like run date, report cohort, metrics run
 * need to know schema for report, cohort records in Wikimetrics database

-- IDEATION --
Stories below are not fully scoped or defined.

Report cohort edits across wikis using CentralAuth Extension

 * Stories
 * Cohort creator configures a report to return results for cohort users' activity across all projects where those users made edits.
 * This is different from Story "User creates cohort with CentralAuth insertions" because it happens during the report generation. The cohort is expanded at that time.

Notes
 * should be able to report both aggregated metrics per project (sum all users) and metrics for individual users per project
 * querying against central auth at reporting time allows a 'refresh' of the cohort by adding new projects that cohort members may have become active on in the intervening weeks or months since the cohort was created
 * see also Analytics/Wikimetrics/Adding_New_Features/CentralAuth_Cohorts

Wikimetrics superuser can view and change other users' datasets

 * Story: Grantmaking officer has special userright allowing them to perform any action on a Wikimetrics users' cohorts that the user themselves can perform: tag, untag, delete cohort, delete user from cohort, run reports.

Notes
 * may not need to have a admin interface initially: admin can use spreadsheet report as reference for finding cohorts. See

View cohort report output in Vital Signs dashboard

 * Story: WikiMetrics user can run a report and then easily create a Vital Signs dashboard that shows Global Metrics by that cohort across time and across projects.

Notes
 * is the dashboard available via a persistent URL?
 * is the dashboard publicly available?
 * can the dashboard page be a) refreshed when report is re-run, and/or b) set to refresh automatically on a scheduled basis ("b" requires scheduled reporting... a separate story)
 * how does a user delete a dashboard they created?

-- STORY NEEDED --

 * 1) Wikimetrics ignore headers in cohort upload files
 * 2) list reports run with a cohort on the cohort page
 * 3) inspect a cohort on cohort page
 * 4) link to metric definition wikipages on metrics page
 * 5) share/unshare cohorts with other Wikimetrics users
 * 6) add notes about a cohort