search

BrianNathanWhite / OpenLong

Shares Synthetic Longitudinal Data And Code For Formatting Real Data
Other
2 stars 2 forks source link

Populating the readme #3

Open bcjaeger opened 1 month ago

bcjaeger commented 1 month ago

We should include some basic info in the readme

  1. What's the goal of the R package
  2. Who is it for?
  3. What cohorts will be included?
  4. What format are the data provided in, and why?
  5. Once we have more code, an example showing how to load and use the data would also be a great addition
bcjaeger commented 3 weeks ago

@simar7511, would you be willing to work on this issue? Here are steps you could take to complete it:

  1. If you haven't already forked and cloned OpenLong, run 1usethis::create_from_github(“BrianNathanWhite/OpenLong”, destdir = “path/to/your/projects”)in your R console to fork and cloneOpenLong`.
  2. Create a new branch, preferably call it “issue3” since this is issue # 3.
  3. Fill in the readme with a first draft, answering the questions I wrote in the issue.
  4. Knit the readme and update your work until you’re happy with it.
  5. Commit the modifications of the readme to your branch
  6. Push your branch to your fork of OpenLong, e.g., git push -u origin issue3
  7. Navigate to your forked repo branch and open a PR
  8. Request my review on the PR
BrianNathanWhite commented 2 weeks ago

@bcjaeger I can take care of this is Simar is busy with other things.

bcjaeger commented 2 weeks ago

Awesome! I'll check in with her tomorrow and circle back.

bcjaeger commented 2 weeks ago

All yours =]