Skip to content

Strategy to split out fileio.Rmd into pieces #267

@bryanhanson

Description

@bryanhanson

@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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions