AlexsLemonade / AlexsLemonade/refinebio-examples

Create a template Rmd specifically for advanced topics/usage examples

Open
#372 0 comments 1 reaction 0 assignees View on GitHub
advanced topics process
Dominant language
HTML
Stars
11
Forks
7
PR merge metrics
No merged PRs in 30d

Description

### Background

Context is #357 - please read the initial comment for that issue in detail!

### Problem

The advanced topics notebooks have a different audience and it stands to reason that those users will have a bit more experience with things like file paths and the different platforms. We can't assume that those users have gone through our other examples (e.g., we should still treat them as independent). We should try to strike a balance between making sure folks can get up and running with refine.bio data but give more information so they can understand whether an analysis is appropriate for their question.

### What potential "gotchas" do we know of?

I expect most gotchas will become apparent while we work our way through #357. Because we want to give users an idea about whether or not an advanced approach is right for them, I'm imagining a mostly blank section in the template that's about _why_ to use an analysis.

### What are the recommended next steps?

1. Add introductory material to our first advanced topic example, which is WGCNA (#357).
2. Create a template Rmd specifically for our advanced topics examples.
3. Update CONTRIBUTING.md to reflect that there will be two templates to choose from.

Contributor guide

Open the contributing guide

Research direction

Start by reading the initial comment on #357 and reviewing the first advanced-topic example, WGCNA, to understand the introductory material and template needs. Then inspect CONTRIBUTING.md and define the separate advanced-topics Rmd template. Done means the template exists, the WGCNA example has its introductory material, and CONTRIBUTING.md explains both templates.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.