Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
vignette for simple use cases? #26
I thought the vignette was helpful. Perhaps some very short examples could also be helpful?
Here's a very short, concrete example that for the user would be:
I was able to get this working for my use case in one-line of code. I have a package and I have some baseline data for unit tests that I was storing in an .Rds file:
Previously, I had some if-then syntax for whether I was running interactively or via
So I replaced the above with the below:
I can write up a short vignette & start a PR if you'd like. Thanks for making my life better!
I don't think anything is missing at all!
I opened the issue because the power and flexibility of
I can add my thoughts to the vignette. Should I PR to master, develop, or some other branch?
If you're tinkering in the vignette ... if there are lots of reference files, it can be nice to create a folder for them and a helper function in