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

Documentation in S3 method visr() #301

Closed
ddsjoberg opened this issue Jan 10, 2022 · 1 comment · Fixed by #356
Closed

Documentation in S3 method visr() #301

ddsjoberg opened this issue Jan 10, 2022 · 1 comment · Fixed by #356
Assignees
Labels
bug Something isn't working issue Used for project filtering
Milestone

Comments

@ddsjoberg
Copy link
Collaborator

ddsjoberg commented Jan 10, 2022

Some arguments are documented for each class/method. When these arguments are documented multiple times, the last one is used in the help file.

For example, the visr(x=) argument is documented as

  • @param x Object of class 'survfit'
  • @param x Object of class 'attritiontable' with each row corresponding to an inclusion step in the cohort and minimally a description and a count column

Only the last one is shown in the rendered help file.

@ddsjoberg ddsjoberg added bug Something isn't working issue Used for project filtering labels Jan 10, 2022
@SHAESEN2 SHAESEN2 added this to the v0.3.0 milestone Feb 26, 2022
@SHAESEN2 SHAESEN2 self-assigned this Apr 13, 2022
@SHAESEN2
Copy link
Collaborator

Proposal to put all documentation at the top instead of per method.
@param x. We can use markdown syntax for a bulleted list to specify for which class x represents what.

@param x a visR object

  • objects of class survift
  • object of class something else
    @param x a visR object
  • objects of class survift
  • object of class something else

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working issue Used for project filtering
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants