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

Review and update template and vignette that is related to tm_g_pp_therapy.R #975

Closed
7 tasks done
Tracked by #919
shajoezhu opened this issue Jan 26, 2024 · 1 comment · Fixed by #1025
Closed
7 tasks done
Tracked by #919

Review and update template and vignette that is related to tm_g_pp_therapy.R #975

shajoezhu opened this issue Jan 26, 2024 · 1 comment · Fixed by #1025
Assignees
Labels

Comments

@shajoezhu
Copy link
Contributor

shajoezhu commented Jan 26, 2024

  • No typos, no wrong formats
  • Make sure there is a meaningful description for every module function @shajoezhu, @khatril, @pawelru - adding here TLG-c general link
  • @example tag, make sure it runs, fix if otherwise
  • Make sure functions have @return tag to document the return value (@edelarua to decide which standard to use, they have all same output in form)
  • no \dontrun tag, replace with if(interactive()) if needed
  • tmc has argument_convention that serves as parameters template, make sure this is utilized correctly (i.e. no repetition of parameters).
  • Adding links to specific templates in TLG-c if already mentioned
@shajoezhu shajoezhu mentioned this issue Jan 26, 2024
38 tasks
@shajoezhu shajoezhu added the sme label Jan 26, 2024
@m7pr
Copy link
Contributor

m7pr commented Jan 26, 2024

@shajoezhu you sure

Package Title is not duplicated in Package Description in DESCRIPTION file
All package names in Title and Description fields of DESCRIPTION file are quoted with '
Review package level documentation (teal.module.clinical.R)

are related to any function? I think those are package specific and you do it once. You don't need this bullet point in every function for which you created an issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants