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

man pages documenting data sets #1

Closed
Helmut01 opened this issue Jun 27, 2017 · 4 comments
Closed

man pages documenting data sets #1

Helmut01 opened this issue Jun 27, 2017 · 4 comments

Comments

@Helmut01
Copy link
Owner

@Helmut01 Helmut01 commented Jun 27, 2017

data(package="replicateBE") does not show the items.

help(data) leads to utils.

help(package="replicateBE") does not show data, only the designs. Clicking on one of them opens the man page for data. Needs to scroll down to the See Also section. Then the desired detailed man page opens.

@Detlew
Copy link
Collaborator

@Detlew Detlew commented Jun 28, 2017

What do you expect for paragraph 1?

Paragraph 2 is the correct behavior I think.

What do you expect for paragraph 3?

@Helmut01
Copy link
Owner Author

@Helmut01 Helmut01 commented Jun 28, 2017

  1. ds <- data(package="replicateBE")
    ds # OK, but
    ds$Item
    When I had man-pages for the individual data sets, ds$Item gave the description
  2. OK, but why - although I have a data.Rd the man-page does not show up?
  3. I see links to the the designs. When I click on them I end up at the man page data. But I want to navigate directly to the man page RTRT.TRTR.
@Detlew
Copy link
Collaborator

@Detlew Detlew commented Jun 28, 2017

  1. Duno
  2. The \name{} entry in man pages is not used for getting help. For that aim the \alias{} are responsible.
    \name{} is on the other hand shown on the man page, left upper corner.
  3. See 2. The aliase in data.Rd are guilty

Will try to resolve.

@Helmut01
Copy link
Owner Author

@Helmut01 Helmut01 commented Jun 28, 2017

Now all data sets have an attribute (the MD5 not needed any more). Warnings about undocumented objects in build. Had to introduce aliases. Try: data(package="replicateBE").

@Helmut01 Helmut01 closed this Jun 28, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.