search

vast-lib / tinyVAST

Expressive interface for multivariate spatio-temporal models
https://vast-lib.github.io/tinyVAST/
GNU General Public License v3.0
10 stars 2 forks source link

Adding README.Rmd #22

Open James-Thorson-NOAA opened 8 months ago

James-Thorson-NOAA commented 8 months ago

@seananderson I like the sdmTMB style of compiling the Readme from a Readme.Rmd file, and think I'll try it out.

However, sdmTMB compiled Readme has front material including badges, short description, and suggested citation, and this front material doesn't appear in the Readme.Rmd.

Can you clarify where that front materials lives in the repo?

And do you just run devtools::build_rmd("Readme.Rmd") or is there some scratch script that walks through what's needed to compile it (I don't see a yaml for GitHub to auto-compile it as an Action)

seananderson commented 8 months ago

Look in the YAML header of the .Rmd and you'll see how it references the header.md file. I believe I only did that to get the table of contents after the header stuff, so if you don't care about the table of contents then you can just put everything in the Rmd.

See devtools::build_readme(). Figures can be an issue (git wanting to commit new ones that are basically identical) but I'll just revert those changes locally before pushing.