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

Reduce duplication in vignettes and inst/documentation #61

Open
ha0ye opened this issue Mar 3, 2022 · 0 comments
Open

Reduce duplication in vignettes and inst/documentation #61

ha0ye opened this issue Mar 3, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@ha0ye
Copy link

ha0ye commented Mar 3, 2022

There is detailed description of the models as both a vignette and inst/documentation (I presume the latter is so the Shiny app can display the model description).

It would simplify maintenance to have the contents for the two Rmd files in one place, so that any changes only need to made in one place.

Possible solution

I believe this can be done by using R markdown child documents.

So an example would be to replace the contents of both vignettes/model-description.Rmd and inst/Documentation/ProjectionModel.Rmd with something like

```{r, child='model-contents.Rmd')}
```

OR

```{r, child='../../vignettes/model-contents.Rmd')}
```

depending on the file, so that the corresponding local path is correct.

@ha0ye ha0ye added the enhancement New feature or request label Mar 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant