Issue 9: Getting started vignette

[athowes]

Description

This PR will close #9.
It is a draft of a rewritten version of the first "Get started" vignette.

Checklist

• My PR is based on a package issue and I have explicitly linked it.
• I have included the target issue or issues in the PR title in the for Issue(s) issue-numbers: PR title
• I have read the contribution guidelines.
• I have tested my changes locally.
• I have added or updated unit tests where necessary.
• I have updated the documentation if required.
• My code follows the established coding standards.
• I have added a news item linked to this PR.
• I have reviewed CI checks for this PR and addressed them as far as I am able.

[seabbs]

This looks good so far. Give me a ping when you want a proper review

[athowes]

@seabbs @kgostic -- I'm not fully done with this but would be interested in some review / feedback to make sure that I'm staying on the right path.

If you'd prefer to wait until the vignette is more fully complete, then let me know.

[athowes]

I will now try fixing this pkgdown error so that you should hopefully be able to extract out the .html version of the vignette.

[athowes]

I don't know what is causing the issue with the pkgdown website on check. I can render it OK locally. Let me know if you have any idea. It is also there on the other PR so it must be something already in main.

[kgostic]

@seabbs -- can you help with this tomorrow?

[kgostic]

@athowes this looks great overall. Your writing is really clear and concise.

I do think there's a bit at the end that still needs to be fleshed out, but if you can finish off the end, I think this is a reasonable outline for a getting started vignette.

@seabbs may want to add a bit more about installation and contributing issues at the top.

I'm approving so as not to hold things up but it would be really nice to see a rendered version of the makrdown as I haven't yet seen the figures in situ.

[seabbs]

Can you rebase this so the pkgdown builds and then I will review (I thought about rebasing myself but it seemed a bit cheeky)

[athowes]

@seabbs may want to add a bit more about installation and contributing issues at the top.

Agree on making sure people have the package installed, but would be tempted to have that displayed very prominently in the README and not in the "getting started" vignette. As well, FWIW and could be convinced, but I don't guess that the top of this vignette is the right place for anything long about contributing issues. Could be open to a short one sentence about it.

[seabbs]

Agree on making sure people have the package installed, but would be tempted to have that displayed very prominently in the README and not in the "getting started" vignette.

Agree

[seabbs]

I really like this @athowes it is really clearly written and communicates the points very well.

I put a few minor comments. My only other concern here is maybe length but uncertain.

[seabbs]

When ready for another review cna you reping using the interface at top right (as this gives a different form of notification that I filter for vs saying something like ready for review)

[athowes]

Great, thanks all for the comments both.

I'm going to give this another hour or so try, and then I think we should clear it up and merge it in to get things moving. Happy to come back and iterate it again in future.

Have enjoyed writing this and the comments / feedback process by the way! Very smooth / logistically easy to handle.

[seabbs]

Actions points I see are:

• Decide on if telling people about packages: did tell people
• Add gt to the suggests: done
• Decide on use of posterior vs from scratch output extraction: I don't know how to do it in posterior so doing from scratch
• New issue for looking again at plotting to either use package plots, remove package plots or standardise themes: created issue Update figures in vignettes #55
• Move @athowes from a contributor to an author in the DESCRIPTION: athowes is already "aut" (?)
• Close all resolved conversations with clarification if useful: done, including creating issue Add right truncation figure to getting started vignette #56
• Fix linting issues
• Make ready for review and ping

[seabbs]

LGTM. This looks to have covered all review points from myself and @kgostic.