search

getwilds / guide

WILDS Dev Guide
https://getwilds.org/guide/
Creative Commons Zero v1.0 Universal
2 stars 1 forks source link

Include anything about the hutch or dasl in WILDS software? #14

Closed sckott closed 8 months ago

sckott commented 10 months ago

@seankross @vortexing @tefirman

Should we mention anything about the hutch or dasl in the software itself?

For example, in R packages there's a way to include a company/organization/etc. that's either a copyright holder or funder. At ropensci we did like this https://github.com/ropensci/vcr/blob/main/DESCRIPTION#L21

person("rOpenSci", role = "fnd", comment = "https://ropensci.org")

And Posit does https://github.com/tidyverse/dplyr/blob/main/DESCRIPTION#L15

person("Posit Software, PBC", role = c("cph", "fnd"))

I don't know if there's anything formal in Python packaging land along these lines, but surely it could be informally included if we think it's necessary.

I don't have a strong opinion either way here, but figure it's due diligence to raise the issue. thanks y'all

sckott commented 9 months ago

(pinged them in slack)

tefirman commented 9 months ago

I think it would be smart to put DaSL maybe as one of the authors, so that people can reach out with questions even after the human authors move on to other orgs. The formal way people do it in python is via the "pyproject.toml" configuration file of the repo, but you could even just put it in as a "magic attribute" in the __init.py file (e.g. __credits = 'Fred Hutch DaSL').

sckott commented 9 months ago

thanks @tefirman !

sckott commented 9 months ago

From Taylor: In Python, we could list the WILDS/DaSL email account as one the maintainers ("name" isn't a required field). There's also a bunch places in the URL section that could point to the WILDS/DaSL webpage.

seankross commented 9 months ago

I largely agree with everything that's been said. Let's specify Fred Hutch as a funder rather than a copyright holder. Also I would prefer that information is specified in an appropriate config file rather than a code file. I'm actively figuring out the email address situation with Amy.

sckott commented 9 months ago