Group functions in pkgdown reference page?

[bcjaeger]

Hello! I was reviewing the outstanding docs in the pkgdown website and I noticed many functions in the reference page (https://motrpac.github.io/MotrpacBicQC/reference/index.html) could be grouped (e.g., all the functions that start with check_).

Would it be helpful to organize the functions into groups and annotate the groups with high-level descriptions, similar to the organization shown here: https://docs.ropensci.org/aorsf/reference/index.html?

If yes, I'd love to initiate a PR and modify based on your feedback. This would be a great way for me to get more familiar with all the functions in the package and what they do. 😀

[biodavidjm]

Thanks a lot @bcjaeger

Sounds good to me. I propose that you outline what you envision, let's review it, polish it, and move forward.

Btw, let's start from version 0.9.4 (released today)

[bcjaeger]

Sounds great, and congrats on the release!

[bcjaeger]

Sorry for the delay following up! Here is a first draft. The function titles will be left as-is, so I didn't include them here.

Colors

Use standardized colors from the MoTrPAC consortium.

• group_cols
• sex_cols
• tissue_cols

Abbreviations

Use standardized abbreviations from the MoTrPAC consortium.

• group_abbr
• sex_abbr
• tissue_abbr

Meta data

Dictionaries and code lists for MoTrPAC data

• bic_animal_tissue_code
• assay_codes
• metabolomics_data_dictionary
• all functions that start with metadata

Adherence to MoTrPAC guidelines

Checks/validations to assert that different objects follow expectations

• all functions that start with check
• all functions that start with validate

Load/write batch data from file

Load and write batch data from files

• all functions that start with load
• all functions that start with write

Visualize results

Create basic charts for quality control

• all functions that start with plot
• proteomics_plots_rii

Miscellaneous

Helpers and stand-alone functions for quality control

• all functions not in another category

Do you think these groups make sense?

[bcjaeger]

@biodavidjm would you like me to submit a PR with the groups above?

[biodavidjm]

Hi @bcjaeger, that's a lot of amazing work that would significantly improve the package and, of course, it would be greatly appreciated. Please, go ahead.

Thanks!

[bcjaeger]

No problem! I'll get to work on it this week.