Clean up non-idiomatic code in vignette

Open
#14 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Locate the vignette referenced by the issue and review the examples using colData(cpd) and ggplot(as.data.frame(colData(cpd))). Update the examples to use the shorter access and current ggplot2 usage, then render or run the vignette to confirm the examples work and the wording is cleaned up.

Written by the indexing model from the issue text.

Description

from @antagomir

While I went through the vignette, I noticed some minor points that you may find useful for your next version. Use as you wish:

  1. colData(cpd)$country (and other similar cases) can be also written more shortly just like: cpd$country
  2. ggplot(as.data.frame(colData(cpd)))... -> the as.data.frame() was necessary until very recently, but not needed any more since the issue was solved ; the latest ggplot2 version allows this:
    ggplot(colData(cpd))... 
    
    We are adding a reference to this data resource in the OMA Gitbook (beta version, under active development)
Dominant language
R
Stars
17
Forks
3
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from blekhmanlab/MicroBioMap

All issues in blekhmanlab/MicroBioMap

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.