-
Notifications
You must be signed in to change notification settings - Fork 232
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
Added full MARC role support, using the specification at http://www.loc.gov/marc/relators/relaterm.html #662
Conversation
…oc.gov/marc/relators/relaterm.html. Lowercased all role descriptions, as in the original list of roles.
Following my comment earlier this week, I did think today to add one additional note through an example. While it is likely that most projects will not have a need to recognize woodcutters or lyricists, several MARC codes have been useful for me in a recent project to accurately assign credit where it's due: In addition to Author (aut) and Creator (cre), these have been helpful to use for this particular project:
Allowing use of all MARC roles also follows Allen, Scott, Brand, Hlava, and Altman's (2014) call in Nature to assign credit more broadly and accurately, by allowing authors to use codes that map well onto Allen et al.'s proposed taxonomy of credit. Again, thank you for your work on this project! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please also add a bullet to NEWS briefly describing the change and acknowledging yourself and this PR, copying the style in the other entries.
R/object-package.R
Outdated
"fnd" = "funder", | ||
"ths" = "thesis advisor", | ||
"trl" = "translator" | ||
"abr" = "abridger", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please match the existing indent?
@hadley, can do! I've pushed two commits with the following changes:
|
I included a link to the MARC Relator codes list from the Library of Congress in the NEWS bullet, but realize that links aren't included in any of the other bullets. Thus, I'm happy to remove it if necessary. |
NEWS.md
Outdated
@@ -52,6 +52,9 @@ | |||
|
|||
## Minor improvements and bug fixes | |||
|
|||
* `person` now supports all [MARC Relator](http://www.loc.gov/marc/relators/relaterm.html "MARC Relator roles") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can remove "MARC Relator roles"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've now removed it, in commit c771b0f.
Thanks! |
Thank you! I appreciate your consideration, and your work more generally! |
Hello,
First, thank you for your work on
roxygen
! It's a wonderful tool.This Pull Request adds support for the full standardized list of MARC roles for contributors to a package.
This Pull Request stems from a question I posted on StackExchange earlier today. I noticed that
?mypackagename
returns[NA]
for any contributor under "Author(s)" when that person's role is listed as any of many valid MARC roles -- for example, if Jane Smith below is listed ascsp
(Consultant to a Project).Example part of DESCRIPTION file:
Relevant output from
?mypackagename
:Thus, aside from viewing the source code of the package, readers of the package documentation would not be able to tell what role Jane Smith had in the project.
This confused me for several reasons:
(I recognize that Dr. Wickham's book is not connected to this package, but it is a popular resource for users; thus, others may have the same confusion in the future.)
?person
states that "The new scheme ... adds the possibility of specifying roles based on a subset of the MARC Code List for Relators (https://www.loc.gov/marc/relators/relaterm.html). When giving the roles of persons in the context of authoring R packages, the following usage is suggested." [emphasis added]Thus,
?person
does not state that only a subset of the MARC list should be recognized, only that it suggests the use of 9 roles (author, compiler, contributor, copyright holder, creator, contractor, data contributor, thesis advisor, and translator).roxygen
recognizes is already larger than the list given in?person
:?person
suggests the 9 roles listed above, whileroxygen
additionally recognizes a 10th, funder.With all this in mind, would you consider adding support for the full list of MARC roles (by accepting this Pull Request)? By doing so, the list would still by curated and standardized (through MARC), but would be less potentially confusing to users trying to figure out which roles are supported.
This PR makes just one change to the
roxygen
code, to expand therole_lookup
vector inobject-package.R
.Thank you for your work, and for your consideration!