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.

Sign up for GitHub

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

Jump to bottom

Suggest to use roxytest for testing documentation #35

Merged

MeWu-IDM merged 1 commit into main from mewu/roxytest

Jun 17, 2022

Collaborator

MeWu-IDM commented Jun 17, 2022

https://cran.r-project.org/web/packages/roxytest/vignettes/introduction.html
with this tool we can identify missing documents and later on test examples
if you run it roxygen it will output like this

 * Function 'CheckInputExcelFileFormat()' with title 'Perform Sanity Checks On Input Excel File': 
    - Missing @param's: scenarioSheet, seasonalityOffsetsSheet
    + Too many @param's: scenariosSheet
* Function '.fRatesRibbonPlot()' with title 'Plot Fertility Rates Statistics As Ribbon Plot': 
    - Missing @param's: df
    + Too many @param's: results
...


          Suggest to use roxytest for testing documentation

3bf77e8

https://cran.r-project.org/web/packages/roxytest/vignettes/introduction.html

MeWu-IDM requested a review from celiot-IDM

June 17, 2022 19:05

celiot-IDM approved these changes

View reviewed changes

Collaborator

celiot-IDM left a comment

Great idea!

MeWu-IDM marked this pull request as ready for review

June 17, 2022 22:19

MeWu-IDM merged commit 17b38d2 into main

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet