Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Structure the tutorials #60

Open
chryswoods opened this issue Oct 25, 2023 · 0 comments
Open

Structure the tutorials #60

chryswoods opened this issue Oct 25, 2023 · 0 comments
Assignees
Milestone

Comments

@chryswoods
Copy link
Collaborator

Structuring the tutorials.

Divide into sections - one page introduces the section, and then have one separate page per subsection. But experiment with what works best within the pkgdown format.

Stage 1 - Input

Need to have tutorials on how to generate SummarySets and DataSets from different data sources.

  • input_simGWAS
  • input_simulateGP
  • input_textfiles
  • input_opengwas
  • input_object

Stage 2 - Processing

  • liftover
  • harmonising
  • meta-analysis
  • ld
  • accessing and editing the data
  • merging
  • subsetting

Stage 3 - Output

  • output_twosamplemr
  • output_coloc
  • output_carma
  • output_susier

Quick start / example guide - Bringing it all together

Need to have walkthroughs for a full analysis.

  • example_mr
  • example_coloc

Developer Documentation

  • Information on the design of the package / how classes work
  • Information about classes / APIdocs
@chryswoods chryswoods added this to the Tutorial milestone Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants