Skip to content
This repository has been archived by the owner on Apr 25, 2019. It is now read-only.

Convert Examples to demos or vignettes #18

Open
ClaytonJY opened this issue Aug 18, 2015 · 1 comment
Open

Convert Examples to demos or vignettes #18

ClaytonJY opened this issue Aug 18, 2015 · 1 comment
Assignees

Comments

@ClaytonJY
Copy link
Contributor

The Examples/ directory is currently a collection of 4 R scripts which are essentially demos. This should be formalized demos; currently, a user has no good way to run these Examples anyways.

According to Hadley, demos are inferior to vignettes. Not only that, but demos appear to be ran from wherever a user types demo(), which would be a problem for the paths in the xqt scripts (which would themselves be moved to extdata). If it was instead the case that demos run from RQt/demo/ in our case, we could more easily get the paths working and stick with demos for now.

According to the same link, the demos aren't even checked automatically, though I wouldn't be surprised if the CRAN maintainers checked them manually, at least for the first submission of a package.

I'll make a branch and edit things assuming demos are ran from RQT/demo, but again @javadch will have to test for me. If that doesn't work we either need a different way to inject paths into an xqt script, or we need to write a vignette for these long examples.

@ClaytonJY ClaytonJY self-assigned this Aug 18, 2015
@ClaytonJY ClaytonJY added this to the RQt 0.1: Prepare for CRAN milestone Aug 18, 2015
@ClaytonJY
Copy link
Contributor Author

Before I do this I think we should address #17 .

javadch added a commit that referenced this issue Aug 19, 2015
The Java Home auto detection issue #15 was fixed
moved the config folder from the  root to the inst/
moved the Examples folder from the  root to the inst/ (@clayton: you may change it according to #18)
Changed the documentation examples
removed the PowerPoint presentation (wish could place it somewhere, maybe along side with demos)
Improved exception reporting and logging
All documentation examples and R examples: Examples/R/RQtTest2.R, Examples/R/WeatherQt.R, Examples/R/weatherR.R are working. (renaming is encouraged)
Everything works fine, Just one NOTE that is complaining about the java folder size.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant