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

Updates to vignettes and pkgdown #144

Merged
merged 16 commits into from
May 2, 2023
Merged

Updates to vignettes and pkgdown #144

merged 16 commits into from
May 2, 2023

Conversation

joshwlambert
Copy link
Member

This PR addresses:

Update vignettes:

  • now using CSL-JSON to handle bibliography
  • link citations

Improved pkgdown site:

  • Add custom function reference to group functions
  • Add custom article reference to group and navbar header to vignettes
  • Turn on code folding in vignettes (default show code, except for plotting chunks)

Removed functions from reference:

  • create_prob_dist() (exported -> unexported)
  • check_optim_conv() (unexported in manual -> unexported not in manual)

@joshwlambert joshwlambert added documentation Improvements or additions to documentation enhancement New feature or request website labels Apr 28, 2023
@joshwlambert joshwlambert requested a review from Bisaloo May 2, 2023 07:58
@joshwlambert
Copy link
Member Author

Ideally, ends_with() or matches() would be used for the <epidist> and <vb_epidist> methods in the pkgdown reference. However, the distributions functions are methods of these classes and they are separated under their own header in the pkgdown reference. For this reason only <epiparam> uses ends_with() to group class methods.

_pkgdown.yml Outdated Show resolved Hide resolved
@Bisaloo
Copy link
Member

Bisaloo commented May 2, 2023

Ideally, ends_with() or matches() would be used for the and <vb_epidist> methods in the pkgdown reference. However, the distributions functions are methods of these classes and they are separated under their own header in the pkgdown reference. For this reason only uses ends_with() to group class methods.

You can create complex selection combinations in pkgdown index. E.g., ends_with("\\.epidist) and not tagged with with a specific keyword.

For example:

epiverse-trace/linelist@372d288#diff-4696b5e124c0b2a7e0ef4617c2e5be11de4ea153568c38fe79ee4925a8cb6b2e

@joshwlambert
Copy link
Member Author

@Bisaloo Thanks for the tip, I didn't realise this was possible. Updates applied in a1cf03d

Co-authored-by: Hugo Gruson <Bisaloo@users.noreply.github.com>
@joshwlambert joshwlambert merged commit 773e709 into main May 2, 2023
@joshwlambert joshwlambert deleted the web_vigs branch May 2, 2023 10:25
@jamesmbaazam
Copy link
Member

This PR is very insightful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants