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

General Issue: Identify the functions and corresponding function argument documentation that need these updates and list out. #166

Closed
Tracked by #72
zdz2101 opened this issue Nov 8, 2022 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@zdz2101
Copy link
Collaborator

zdz2101 commented Nov 8, 2022

Please select a category the issue is focused on?

Let us know where something needs a refresh or put your idea here!

Identify the functions and corresponding function argument documentation that need these updates and list out.

@zdz2101 zdz2101 changed the title Identify the functions and corresponding function argument documentation that need these updates and list out. General Issue: Identify the functions and corresponding function argument documentation that need these updates and list out. Nov 8, 2022
@zdz2101
Copy link
Collaborator Author

zdz2101 commented Nov 8, 2022

Original mention, including initial draft

Link to current file on box

@zdz2101 zdz2101 self-assigned this Nov 8, 2022
@zdz2101 zdz2101 added the documentation Improvements or additions to documentation label Nov 8, 2022
@zdz2101
Copy link
Collaborator Author

zdz2101 commented Nov 11, 2022

Inspired by #11 and #80 , and #270 might be helpful to incorporate an add-in that can be run on a .R script that identifies lines of code in the roxygen section that can potentially use some edits and incorporate the default defined in the function header.

zdz2101 pushed a commit that referenced this issue Nov 11, 2022
zdz2101 pushed a commit that referenced this issue Nov 11, 2022
zdz2101 pushed a commit that referenced this issue Nov 11, 2022
zdz2101 pushed a commit that referenced this issue Nov 11, 2022
zdz2101 pushed a commit that referenced this issue Nov 11, 2022
zdz2101 pushed a commit that referenced this issue Nov 11, 2022
zdz2101 pushed a commit that referenced this issue Nov 11, 2022
@zdz2101
Copy link
Collaborator Author

zdz2101 commented Nov 11, 2022

To try, install this branch of admiraldev that contains an initial version of the add-in:

remotes::install_github("pharmaverse/admiraldev", ref = "166_default_permittedval_identifier_addin@devel")

proceed to load admiraldev using

library(admiraldev) and the following add-in should be available:

Image

Proceed to use add-in on "./R/xxx.R" files in admiral, and it should generate documentation for default if function header contains one

@zdz2101
Copy link
Collaborator Author

zdz2101 commented Jun 21, 2023

Closing to centralize as denoted in pharmaverse/admiral#1976

@zdz2101 zdz2101 closed this as completed Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

No branches or pull requests

1 participant