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

Closes #1839 Add my_first_fcn for onboarding #2478

Closed
wants to merge 1 commit into from

Conversation

biocyberman
Copy link

Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral codebase remains robust and consistent.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the main branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
  • Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
  • Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide
  • If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
  • Review the Cheat Sheet. Make any required updates to it by editing the file inst/cheatsheet/admiral_cheatsheet.pptx and re-upload a PDF and a PNG version of it to the same folder. (The PNG version can be created by taking a screenshot of the PDF version.)
  • Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Address any updates needed for vignettes and/or templates: Not applicable
  • Update NEWS.md under the header # admiral (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers). A Developer Notes section is available in NEWS.md for tracking developer-facing issues.
  • Build admiral site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.
    I actually got this error but it is irrelevant, and therefore I will ignore it for now:
Reading man/call_derivation.Rd
Error: 
! in callr subprocess.
Caused by error in `build_reference()`:
! Failed to parse Rd in call_derivation.Rd
Caused by error in `output_handler$source()`:
! argument "expr" is missing, with no default
ℹ See `$stdout` and `$stderr` for standard output and error.
Type .Last.error to see the more details.
  • Address or fix all lintr warnings and errors - lintr::lint_package()
  • Run R CMD check locally and address all errors and warnings - devtools::check()
  • Link the issue in the Development Section on the right hand side.
  • Address all merge conflicts and resolve appropriately: Not applicable
  • Pat yourself on the back for a job well done! Much love to your accomplishment! I did :)

@biocyberman biocyberman linked an issue Jul 12, 2024 that may be closed by this pull request
Copy link

Code Coverage

Package Line Rate Health
admiral 96%
Summary 96% (4953 / 5152)

@manciniedoardo manciniedoardo self-requested a review July 19, 2024 09:06
@manciniedoardo
Copy link
Collaborator

hello @biocyberman - looks good but i think you accidentally committed some renv files?

@manciniedoardo
Copy link
Collaborator

@biocyberman for the build_site error, what version of Roxygen do you have?

@manciniedoardo
Copy link
Collaborator

@biocyberman if you add adxx to inst/WORDLIST then the spellcheck won't flag it up as a misspelled word. then your dummy issue will be complete :)

@bms63 bms63 deleted the 1839_dummy_issue_vangle branch September 9, 2024 12:25
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 this pull request may close these issues.

DUMMY ISSUE FOR ONBOARDING
2 participants