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.

Sign up for GitHub

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

Jump to bottom

Consider a dedicated guide on just the YAML configuration file #32

Closed
wlandau opened this issue Jul 2, 2018 · 4 comments
Closed

Consider a dedicated guide on just the YAML configuration file #32

wlandau opened this issue Jul 2, 2018 · 4 comments
Labels
Ropensci issues

Comments

@wlandau
Copy link
Member

wlandau commented Jul 2, 2018 •
edited
Loading

You touched on the YAML configuration file in the vignette, and it looks useful. I think new users would appreciate a dedicated vignette on that file describing

  • Its purpose in governing how data is processed.
  • What all the fields mean.
  • Which yml_*() functions are available and what they do.
  • An example project that relies on manually modifying the YAML file.
@wlandau wlandau mentioned this issue Jul 2, 2018
Closed
19 tasks
gfinak added a commit that referenced this issue Jul 3, 2018
@gfinak
Add a readme describing the YAML configuration file #32
571bdb2
gfinak added a commit that referenced this issue Jul 5, 2018
@gfinak
This commit and previous should address remaining ropensci reviewer i…
691e8e4 
…ssues.

#21 #22 #23 #24 #25 #26 #27 #28 #29 #30 #31 #32
@wlandau
Copy link
Member Author

wlandau commented Jul 6, 2018

Just saw the remarks in the vignette and YAML_CONFIG.md. I consider this issue solved, but I have 2 questions:

  1. Is there a reason you need the name of each script file to be repeated in the name field? I believe full paths with slashes can still be valid YAML keys.
  2. Is there a reason you prefer YAML_CONFIG.md to be a top-level Markdown document rather than a vignette?

@wlandau wlandau closed this as completed Jul 6, 2018
@gfinak
Copy link
Member

gfinak commented Jul 9, 2018

  1. I wasn't aware that full paths could be keys. I think I could make that change with minimal impact. Will work on it.
  2. No particular reason. I can make it a package vignette instead.

gfinak added a commit that referenced this issue Jul 9, 2018
@gfinak
Address point 2 in #32
d6370fd 
- move YAML_CONFIG to vignettes.
Issue #24
- Add definition of data package to README.
Issue #25
- Move "R CMD build" to section after package_build is introduced.
- Extend the "Purpose" section a bit.
- Extended "Next Steps" and made it a sub-section.
- Referenced "Happy Git and Github for the useR" and Hadley's book on R packages.
- Fix typo mtcars2 to mtcars20
gfinak added a commit that referenced this issue Jul 9, 2018
@gfinak
Address point 1 of #32
73fa029 
- remove "name" property of yaml
- update tests
- upate code
- update yaml_config.rmd
- update vignette links
@wlandau
Copy link
Member Author

wlandau commented Jul 9, 2018

I might actually be wrong about (1) because I did not test with paths with spaces. Sorry about that. Is there still a way to avoid having to duplicate information in the YAML?

@gfinak
Copy link
Member

gfinak commented Jul 9, 2018

Well, paths aren't part of the yaml actually. scripts are stored under data-raw and that path in handled by usethis::proj_get and usethis::proj_set

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Ropensci issues
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gfinak @wlandau