Improve vignette
Issue #15
resolved
The cloning vignette doesn’t read like a tutorial or walkthrough. Most of it is a repeat of the man pages and I think that’s distracting. Thoughts:
- Doesn't state the purpose at the beginning (we want clones, here's how we get clones).
- Has a "Functions" section rather than being broken down by clonal clustering methodology.
- Has big chunks explaining the function arguments, which repeats the man pages and doesn't walk you through actually using the package.
Shorter is better, in my opinion. Just focus on what's important to get people started with the package and leave the advanced details to the man pages.
Comments (3)
-
-
-
assigned issue to
-
assigned issue to
-
- changed status to resolved
finalized by 26acf7a
- Log in to comment
I am changing ‘assignee’ to Nima, because he took over.