Vignette formatting--which features do we like?

[sgaichas]

Now that there are draft vignettes available, each with slightly different styles or formatting, which features do we want to use across all vignettes?

Please leave thoughts in this discussion board so we can implement, thanks!

[andybeet]

For example:

For example:

• Which references format do we want to adopt? (use a bib file across the package, organized in say zotero, or use inline references)

• Andy Beet will make the master list for option 1.

• Do we want to include authors/date in each vignette header?

• Sarah G will remove authors/dates

• Does the list of function in the references need a reorder/recategorization

• Kerim will have a look/thought about list.

• Consider moving some content from Rpath.rmd (getting started) to README.md (like installation instructions)

• Andy Beet

• Rewrite getting started vignette

• Kerim will have a look/thought about list.

• Change dependency on R from 2.1 (DESCRIPTION file)?

• Andy Beet (depends on v3.6.0)

• Still a few data objects undocumented (eg. EBS_bal, EBS_sense)

• Can be deleted? Bia checking

• identify points for past releases

• Kerim will make first attempt.

[andybeet]

Regarding the past release points. These might be a starting point:

july 10, 2019 (Conducting reproducible ecosystem modeling using the open source mass balance model Rpath)
v0.0.1.0 - d10c809

nov 14, 2019
v0.0.1.1 - 8306075

april 6, 2020 (Evaluating fishery management strategies using an ecosystem model as an operating model)
v.0.0.1.2 - ecd48ee

nov 22, 2021
d9fd9fe
(Incorporating temperature-dependent fish bioenergetics into a Narragansett Bay food web model)

april 25, 2022
v0.0.1.3 - b908fee

(during 2023, all changes lived on dev - didn't update to master - did stanza fix really live on dev that long?)

may 31, 2024
v0.9.0 - 26e9661
I think it's - 36e8079
(Assessing the sensitivity of three Alaska marine food webs to perturbations: an example of Ecosim simulations using Rpath)

jun 5, 2024
v0.9.1 - b78aee4
Is it actually - 3c75a6d

[kaydin]

Closing discussion as this has moved to an issue.