rrrlw / icon Goto Github PK

based on advice in Advanced R

based on contributor covenant

The ICON R data package makes available to useRs clean datasets listed on the Index of COmplex Networks (ICON) database at https://icon.colorado.edu/. The chief goal prior to releasing version 0.2.0 is the addition of more datasets of complex networks listed at ICON.

This would be a straightforward, yet educational, task for beginner useRs who would like to eventually develop their own R package as it teaches the important step of including external data in R packages (most packages could benefit from the addition of sample datasets highlighted package use in a vignette, for example). The steps required to successfully add a dataset to the ICON package are listed in this repository's contribution guide. This would also be a relatively guided tasks that could serve first-time open-source contributors well by teaching the very useful process of forking a repository, committing and pushing changes, potentially fetching and pulling other contributors' changes, and finally creating a pulling request to merge the changes back into the original repository.

I will also be slowly adding some datasets from ICON so if you would like to contribute by including a particular dataset, please name it in the comments of this issue (below). If you are unable to complete the task, I would be happy to help - however, if you would prefer not to complete it, it's not a problem. Simply post under the issue stating that you will not be completing inclusion of the dataset you earlier reserved.

Templates of all the steps in the contribution guide can be found in other files in the package (e.g. the data-raw directory for raw data and R conversion script examples, R/data.R for documentation examples). Questions are welcome! Please post them in this issue (or feel free to create a new one).

Allow users to select from available networks and visualize/explore

In R/data.R under format, spelling switch speces --> species

• constructor
• validator
• helper
• print S3 generic method (exported)

All binary .rda files (format NAME.rda) in the data-host directory should have a corresponding NAME.csv and NAME.R file in the data-raw directory. Should use testthat (potentially with skip_on_cran() and/or skip_on_travis()).