search

PIFSCstockassessments / ss3diags

R package with advanced diagnostics to evaluate a Stock Synthesis model. Diagnostics include residual analyses, hindcasting and cross-validation techniques, and retrospective analyses.
http://pifscstockassessments.github.io/ss3diags/
2 stars 4 forks source link

Improve documentation website #73

Closed MOshima-PIFSC closed 9 months ago

MOshima-PIFSC commented 1 year ago

I would like to change the github page so that it is not just the readme documentation. I think we should have multiple pages with descriptions and examples of the functions and how to use them. The vignette documentation could be included as separate pages. We could also include a small section about the example SS model used and where to find the input files.

efletcherPIFSC commented 1 year ago

@MOshima-PIFSC

Do you want to add the vignettes at its current form to the pkgdown site?

Is this related to #72?

MOshima-PIFSC commented 1 year ago

@efletcherPIFSC I think the vignette would need to be broken down a bit more into smaller chunks before adding to the documentation site. I think this may take a little work so it is not an immediate priority. Maybe after the current milestone we have, we can have another one that would be focused on improving overall documentation. It could address issues #71, #75, #73, #78, #67, and #2.

fecor21 commented 1 year ago

Mahalo for flagging this Eric. Yes, agree with Meg. The vignette needs some work, but it can wait for now. FC

On Tue, Jun 6, 2023 at 8:32 AM Meg Oshima @.***> wrote:

@efletcherPIFSC https://github.com/efletcherPIFSC I think the vignette would need to be broken down a bit more into smaller chunks before adding to the documentation site. I think this may take a little work so it is not an immediate priority.

— Reply to this email directly, view it on GitHub https://github.com/PIFSCstockassessments/ss3diags/issues/73#issuecomment-1579262554, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACCZIXN2HXMJKQ2YNKU56ADXJ5ZTNANCNFSM6AAAAAAV5WAWZ4 . You are receiving this because you are subscribed to this thread.Message ID: @.***>

-- Felipe Carvalho, Ph.D.

Supervisory Research Mathematical Statistician Stock Assessment Program Leader NOAA Pacific Islands Fisheries Science Center Website: PIFSC Stock Assessment https://pifscstockassessments.github.io/ | PIFSC https://www.fisheries.noaa.gov/region/pacific-islands#science | Bio https://www.fisheries.noaa.gov/contact/felipe-carvalho-phd