First of all, thanks for considering contributing to HistData! 👍 It's people like you that make it rewarding for us - the project maintainers - to work on HistData. 😊
HistData is an open source project.
Please note that the HistData project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
There are several ways you can contribute to this project. If you want to know more about why and how to contribute to open source projects like this one, see this Open Source Guide.
Think HistData is useful? Let others discover it, by telling them in person, via Twitter or a blog post.
Using HistData for a paper you are writing? Consider citing it.
Using HistData and got stuck? Browse the documentation to see if you can find a solution. Still stuck? Post your question as an issue on GitHub. While we cannot offer user support, we'll try to do our best to address it, as questions often lead to better documentation or the discovery of bugs.
Want to ask a question in private? Contact the package maintainer by email.
Have an idea for a new HistData feature? Take a look at the documentation and issue list to see if it isn't included or suggested yet. If not, suggest your idea as an issue on GitHub. While we can't promise to implement your idea, it helps to:
See below if you want to contribute code for your idea as well.
Noticed a typo on the website? Think a data set could use a better or additional example? Good documentation makes all the difference, so your help to improve it is very welcome!
This website is generated with pkgdown
. That means we don't have to write any html: content is pulled together from documentation in the code, vignettes, Markdown files, the package DESCRIPTION
and _pkgdown.yml
settings. If you know your way around pkgdown
, you can propose a file change to improve documentation. If not, report an issue and we can point you in the right direction.
If you have an interesting historical data set you think should be added to the package, first suggest it as an issue on GitHub. To be acceptable for the package, your contribution should consist of:
The data set, as an .RData
or .rda
file, as generated by save(mydata, file="mydata.RData")
. Please make sure that the data set is tidy, and that variable types are appropriate for analysis and plotting. This will go into the data/
directory of the package.
Optionally, you can also submit a new data set as a mydata.csv
file, together with the script, mydata.R
used to create the data.frame. These will go into the data-raw/
directory.
Documentation for the data set, in the form of an .Rd
file, such as generated by promptData(mydata, filename = "mydata.Rd")
. You will need to edit this file to fill in the \title{}
, \description{}
, \references{}
, \source{}
fields, as well as sufficient \examples{}
to illustrate something about the data and/or its context in history.
Optionally, you can document your data set in a mydata.R
file in roxygen2
format. This will go into the R/
directory and be converted to .Rd
format.
We try to follow the GitHub flow for development.
git pull upstream master
..Rproj
).devtools::check()
and aim for 0 errors and warnings.Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.