Skip to content

Docs for notebooks #12

@anwarfg

Description

@anwarfg

Is this the right issue type?

  • Yes, I'm planning work for this project team.

Summary

Some areas to be covered:

  • Preparing for submission (Set up of the config files)

  • General 5STES workflow, to include (there's already some info on this stuff, but we should add more, either as separate pages or just expand on what's there):

    • Request (connection and submission)
    • Processing (on TREs)
    • Arbitrary containers (a shout out to highlight their use, there's already a general page)
      
    • Collection and Aggregation
  • Workbench

  • Basic use Example (notebook linked and explained)

  • Demo containers (bunny, SQL, demo)

  • Detailed examples -

  • Detailed examples - contingency tables using SQL container

  • Detailed examples - descriptive statistics

Acceptance Criteria

  • 5STES workflow explained
  • Workbench notebook explained and linked.
  • Descriptions of our demo containers
  • Example notebooks explained and linked using workbench:
    • Basic use
    • contingency table using sql container
    • descriptive stats using sql
    • contingency using analysis container
    • descriptive stats using analysis container

Confirm creation

  • Ready to create this feature?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Priority

    None yet

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions