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

Create a template Rmd specifically for advanced topics/usage examples #372

Open
jaclyn-taroni opened this issue Nov 23, 2020 · 0 comments
Open
Labels
advanced topics advanced topics process issues about the processes of this repo

Comments

@jaclyn-taroni
Copy link
Member

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 (Try out new Advanced Usage intro/instructions in the WGCNA example #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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
advanced topics advanced topics process issues about the processes of this repo
Projects
None yet
Development

No branches or pull requests

1 participant