Additional attribution information

[mbojan]

Hi @sckott , I have the following question: would you have anything against including the information about the package authors in the oai-package.R file? That would allow me to insert there the grant citation that was supporting my contributions to this package. I imagine a section "Authors" with a bullet for each author and mine as something like "Michal Bojanowski, supported by NCN grant 2012/07/D/HS6/01971". This could be also in README. Or perhaps you'll have a different suggestion.

Bit more background: I used the oai package to collect data for research purposes for my project http://recon.icm.edu.pl . Now I am in for writing the final report and listing various contributions made. I wanted to include my work on extending oai (dumpers etc.) for data collection purposes. This will have no copyright/licensing consequences whatsoever.

What do you think?

[sckott]

sounds good to me. in the package level man file sounds good, and in readme as well. There may be something we can put in a structured way in the DESCRIPTION file - i'll ask about that.

[mbojan]

Great thanks

[mbojan]

structured way in the DESCRIPTION file - i'll ask about that.

person() has a comment argument, perhaps this would be the right place...

[mbojan]

not bad actually:

person("michal", "bojanowski", role="aut", comment="Supported by NCN xxx/xxx/xxx/xxx")
## [1] "michal bojanowski [aut] (Supported by NCN xxx/xxx/xxx/xxx)"

[sckott]

nice, sounds good to me.

also, found some instances of grant mentioned in DESCRIPTION files on github https://github.com/search?utf8=%E2%9C%93&q=user%3Acran+grant+filename%3ADESCRIPTION&type=Code

[mbojan]

Good. I'll submit a PR soon.