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

Missing items from reference/index.html #1935

Closed
wviechtb opened this issue Dec 1, 2021 · 3 comments · Fixed by #1936
Closed

Missing items from reference/index.html #1935

wviechtb opened this issue Dec 1, 2021 · 3 comments · Fixed by #1936

Comments

@wviechtb
Copy link

wviechtb commented Dec 1, 2021

I am running into a very strange problem with the new 2.0 version. Essentially, some of the help pages are not listed under reference/index.html even though they have been rendered and they are also specified to be shown in _pkgdown.yml. See here:

https://wviechtb.github.io/metafor/reference/index.html#plots

The Plots section in _pkgdown.yml includes several other items:

https://github.com/wviechtb/metafor/blob/master/_pkgdown.yml#L87

But they don't show up in the index even though they have been rendered; for example:

https://wviechtb.github.io/metafor/reference/labbe.html

This wasn't a problem before the update. The old pkgdown reference/index.html can be found here:

https://github.com/wviechtb/metafor/blob/17586b90428e7a17c772b0b09a0995bae870ef28/docs_old/reference/index.html#L177

and this includes all of the items.

As far as I can tell, this only pertains to some of the items in the Plots section. Everything else is there. I have tried to remove some items from the Plots section in _pkgdown.yml to figure out if one of these items is the culprit but have not been able to narrow things down. Also, rendering with or without bootstrap: 5 makes no difference.

@hadley
Copy link
Member

hadley commented Dec 1, 2021

@wviechtb
Copy link
Author

wviechtb commented Dec 1, 2021

Okay, after a lot of trial and error, I have noticed this. If I rearrange the Plots section, so that it looks like this:

    contents:
      - funnel
      - regplot
      - baujat
      - labbe
      - radial
      - llplot
      - gosh
      - plot.gosh.rma
      - plot.rma
      - plot.cumul.rma
      - plot.infl.rma.uni
      - plot.profile.rma
      - plot.rma.uni.selmodel
      - starts_with("qqnorm")
      - starts_with("forest")
      - starts_with("addpoly")

then everything shows up in reference/index.html. In other words, if I move starts_with("forest") and starts_with("addpoly") to the end, then this problem disappears. I have no idea why the order matters.

Edit: This also works:

    contents:
      - funnel
      - forest
      - forest.default
      - forest.rma
      - forest.cumul.rma
      - addpoly
      - addpoly.default
      - addpoly.rma
      - regplot
      - baujat
      - labbe
      - radial
      - llplot
      - gosh
      - plot.gosh.rma
      - plot.rma
      - plot.cumul.rma
      - plot.infl.rma.uni
      - plot.profile.rma
      - plot.rma.uni.selmodel
      - starts_with("qqnorm")

that is, getting rid of the starts_with() for forest and addpoly and listing the items manually. So maybe this helps to narrow things down?

Edit 2: A further observation. For starts_with("qqnorm"), all of the items are actually part of the same help page: https://github.com/wviechtb/metafor/blob/master/man/qqnorm.rma.Rd But with forest and addpoly, these are actually spread across different help pages (e.g., see: https://github.com/wviechtb/metafor/tree/master/man). And maybe that is causing some kind of problem.

@wviechtb
Copy link
Author

wviechtb commented Dec 2, 2021

Thanks for looking into this. For the moment, I have rebuilt the docs with the fix where I list the items individually and not use starts_with("forest") and starts_with("addpoly"). Will try to go back to using starts_with() once this fix is pushed through.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants