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

Implement knit_print and render methods for reporting #774

Open
28 of 34 tasks
Puzzled-Face opened this issue Jan 16, 2024 · 1 comment
Open
28 of 34 tasks

Implement knit_print and render methods for reporting #774

Puzzled-Face opened this issue Jan 16, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed high priority

Comments

@Puzzled-Face
Copy link
Collaborator

Puzzled-Face commented Jan 16, 2024

See #768 for design details.

This is the issue to manage implementation of S3 knit_print and S4 render methods for crmPack. Please use the bullet list below to manage the implementation of each sub task in the list. Edit this issue to indicate that you have taken responsibility for each sub-task.

To avoid merge conflicts, I suggest adding new features in files named helpers_knitr_<subtask>.R. Once all sub tasks have been completed, the final step can be to combine all the task-specific files into helpers-knitr.R.

The knit_print methods for each sub-class of GeneralModel will be the longest and most fiddly to write. For this reason I have separated them out into individual sub-tasks. It might be possible to combine the implementation of one or two methods into a single PR.

To do

@Puzzled-Face
Copy link
Collaborator Author

Puzzled-Face commented Feb 7, 2024

It appears that the S3 knit_print methods for each class are not registered until they are documented with devtools::document. Until then, they must be registered manually. For example

registerS3method("knit_print", "IncrementsRelativeDLTCurrent", knit_print.IncrementsRelativeDLTCurrent)

... and the correct way to document them is with

@method <method name> <class name>

for example

@method knit_print CohortSizeConst

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed high priority
Projects
Status: In progress
Development

No branches or pull requests

1 participant