ropensci / visdat

Preliminary Exploratory Visualisation of Data
https://docs.ropensci.org/visdat/
Other
450 stars 47 forks source link

Fix pkgdown configuration for reference #144

Closed maelle closed 1 year ago

maelle commented 1 year ago

Some topics are missing from the configuration file.

Error in check_missing_topics(rows, pkg) : 
  All topics must be included in reference index
• Missing topics: add_vis_dat_pal, all_numeric, compare_print, dat_bin, expect_frame, expect_guide_label, fingerprint, gather_cor, guess_type, label_col_missing_pct, miss_guide_label, scale_01, test_if_dataframe, typical_data, typical_data_large, vis_binary, vis_create_, vis_extract_value_, vis_gather_, vis_value, visdat

Note that for topics you do not want to include in the index you can create an "internal" section https://pkgdown.r-lib.org/reference/build_reference.html?q=internal#missing-topics

To check all topics are listed, after editing the configuration file you can run pkgdown::check_pkgdown().

maelle commented 1 year ago

@njtierney friendly reminder :smile_cat:

maelle commented 1 year ago

@njtierney friendly reminder :smile_cat:

maelle commented 1 year ago

@njtierney Happy New Year! Friendly reminder :smile_cat:

njtierney commented 1 year ago

Finally getting to this! Apologies for the delay.

Hopefully this is resolved in https://github.com/ropensci/visdat/pull/156

njtierney commented 1 year ago

I think this should all be good now, @maelle ? Let me know :)

maelle commented 1 year ago

Yes if https://docs.ropensci.org/visdat/reference/index.html looks ok to you! Thanks a lot!