insightsengineering / cardx

R Package to Supplement ARD Functions Found in {cards}
https://insightsengineering.github.io/cardx/
Other
16 stars 2 forks source link

`_pkgdown.yaml` organization... 🤔 #114

Closed ddsjoberg closed 7 months ago

ddsjoberg commented 7 months ago

@ayogasekaram than you for the big function rename!

I am wondering if we should organize the pkgdown reference page by the source package? Would also need to figure out what to do with the functions not from packages, e.g. the proportion CI functions. What do you think?

ayogasekaram commented 7 months ago

@ddsjoberg I think reorganizing by package makes sense since users would likely want to know the underlying function the ard* one is using. Maybe for the functions not from packages, they could be divided by their input (df vs linear models) - I'm guessing similar input would have similar analyses.

ddsjoberg commented 7 months ago

@ayogasekaram do you want to propose a new structure then implement?

ayogasekaram commented 7 months ago

something like that? @ddsjoberg

ddsjoberg commented 7 months ago

thanks @ayogasekaram ! I think we're thinking similarly. The yaml code would look something like this?

reference:
  - title: "ARD Creation"
  - subtitle: "{aod} package"
  - contents:
      - ard_aod_wald_test
  - subtitle: "{car} package"
      - ard_car_anova

...

   - subtitle: "Other ARD functions"
      - ard_proportion_ci
      - ard_regression
      - ard_regression_basic

  - title: "Helpers"
  - contents:
      - proportion_ci

The thing I was still contemplating is whether ARDs from packages should be its own section and other ARDs should be it's own section, or just add them all together... 🤔

ayogasekaram commented 7 months ago

oh yes, dividing the functions by package does make sense. I can draft up a PR and see how that looks and if you want to make any changes we can adapt :) @ddsjoberg

ddsjoberg commented 7 months ago

Sounds great, thanks @ayogasekaram !