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.

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

Strategy to split out fileio.Rmd into pieces #267

Open
bryanhanson opened this issue Aug 19, 2020 · 2 comments
Open

Strategy to split out fileio.Rmd into pieces #267

bryanhanson opened this issue Aug 19, 2020 · 2 comments
Labels
Topic: vignette 📗 Related to vignettes of hyperSpec

Comments

@bryanhanson
Copy link
Collaborator

@erick is currently editing fileio.Rmd for general corrections and stylistic changes, as well to bring it up to date with the changes in hySpc.read.txt. @GegznaV has noted we need to move the relevant material to hySpc.read.txt to avoid having hyperSpec depend upon hySpc.read.txt due to vignette code.

I suggest that code in fileio.Rmd be set to eval = FALSE during the general editing, keeping in mind this material will be moved. Once you've got this polished up, and also consistent with the formatting etc that were established in hyperSpec.Rmd, copy the whole vignette over to hySpc.read.txt trim it to the relevant material and remove it from the main fileio.Rmd.

In both vignettes please be sure to make liberal use of the list-of-vignettes.md strategy to point users back to basic information in hyperSpec.Rmd. Try hard not to repeat the basic material so we only have that info in one place, for maintenance purposes. Note that you will have to copy list-of-vignettes.md over to hySpc.read.txt which presents its own maintenance issue, but we have the same problems with vignettes.css etc. That's a separate problem to be solved later. We might want to explore a common area to store these files but that is a potential fragility.

And on that topic, once you split out the vignette material list-of-vignettes.md will have to be edited in each repo to reflect the new vignette's existance.

@GegznaV
Copy link
Collaborator

GegznaV commented Aug 19, 2020

In the future, we will make list-of-vignettes.md to be one of the files that is automatically synchronized between repos.

@GegznaV GegznaV added the Topic: vignette 📗 Related to vignettes of hyperSpec label Aug 19, 2020
@eoduniyi
Copy link
Collaborator

Alright, I will gladly do this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Topic: vignette 📗 Related to vignettes of hyperSpec
Projects
None yet
Development

No branches or pull requests

3 participants