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

Use of \concept or \keyword in documentation #7

Closed
kylehamilton opened this issue Sep 15, 2019 · 2 comments
Closed

Use of \concept or \keyword in documentation #7

kylehamilton opened this issue Sep 15, 2019 · 2 comments

Comments

@kylehamilton
Copy link
Collaborator

Currently, in the documentation we are using \concept to describe what the datasets look like. A lot of the tags are for the academic fields of publication such as education or medicine. Do we want this to be how we organize the types of datasets or do we want to use \keyword to describe these datasets? The Writing R Extensions manual says "each \concept entry should give a single index term", for now, I went back into the documentation and removed any case where I used two words in a \concept field but there are a few others currently there. I just wanted to wait until I got direction to make sure I didn't break something.

https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Indices

@wviechtb
Copy link
Owner

The \keyword entries are somewhat standardized (see file KEYWORDS in R_HOME/doc). Of course one can add additional ones, but we decided not to do that. See also: https://cran.r-project.org/doc/manuals/r-release/R-exts.html#index-_005ckeyword where it says "Do strongly consider using \concept (see Indices) instead of \keyword if you are about to use more than very few non-standard keywords." So we went with \concept. And yes, each \concept entry should give a single index term (but there can be multiple entries). We still need to start cataloguing all the terms we use (so that people don't use different terms for the same concept).

@kylehamilton
Copy link
Collaborator Author

Ok thanks for clearing that up, I didn't want to do a bunch of work that I thought was a good idea and find out later that I should have done something else entirely. I'll go ahead and catalog the entries and put something together.

wviechtb pushed a commit that referenced this issue Oct 19, 2019
Merge pull request #5 from kylehamilton/master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants