diff --git a/.gitignore b/.gitignore index 778bf2a..c6ff43a 100644 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,4 @@ vignettes/*.pdf stan/model.rds _targets report.html +.Rproj.user diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2b69395 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,48 @@ +# Contributing + +Development is a community effort, and we welcome participation. + +## Code of Conduct + +By participating in this project, you agree to abide by the [code of conduct](https://github.com/wlandau/targets/blob/master/CODE_OF_CONDUCT.md). + +## Issues + +Anyone can submit an issue to or comment on an existing thread. Common reasons are to + +* Suggest features. +* Report bugs. +* Request help with difficult use cases. +* Ask questions. + +Please abide by the following guidelines. + +* Before posting a new issue, please take a moment to search for existing similar issues in order to avoid duplication. +* For bug reports: if you can, please install the latest GitHub version of `targets` (i.e. `remotes::install_github("wlandau/targets")`) and verify that the issue still persists. +* Describe your issue in prose as clearly and concisely as possible. The following three-paragraph format is preferred. + 1. State the general problem or question in 1-2 matter-of-fact high-level sentences. + 2. Explain supporting context and details necessary to understand paragraph 1. + 3. Suggest solutions, implementation details, or other ideas if you have them. +* Include diagnostic details about the problem, including + * A [reproducible example](https://github.com/tidyverse/reprex). + * Session info, available through `sessionInfo()` or [`reprex(si = TRUE)`](https://github.com/tidyverse/reprex). + * A stack trace from `traceback()` or `rlang::trace_back()`. + * The [SHA-1 hash](https://git-scm.com/book/en/v1/Getting-Started-Git-Basics#Git-Has-Integrity) of the GitHub commit of `targets` currently installed. `packageDescription("targets")$GithubSHA1` shows you this. + +## Development + +External code contributions are extremely helpful in the right circumstances. Here are the recommended steps. + +1. Prior to contribution, please propose your idea in a [new issue thread](https://github.com/wlandau/targets-minimal/issues) so you and the maintainer can define the intent and scope of your work. +2. [Fork the repository](https://help.github.com/articles/fork-a-repo/). +3. Follow the [GitHub flow](https://guides.github.com/introduction/flow/index.html) to create a new branch, add commits, and open a pull request. +4. Discuss your code with the maintainer in the pull request thread. +5. If everything looks good, the maintainer will merge your code into the project. + +Please also follow these additional guidelines. + +* Respect the architecture and reasoning of the project. +* If possible, keep contributions small enough to easily review stanly. It is okay to split up your work into multiple pull requests. +* Format your code according to the [tidyverse style guide](https://style.tidyverse.org/) and check your formatting with the `lint_package()` function from the [`lintr`](https://github.com/jimhester/lintr) package. +* Describe your contribution in the project's [`NEWS.md`](https://github.com/wlandau/targets/blob/master/NEWS.md) file. Be sure to mention relevent GitHub issue numbers and your GitHub name as done in existing news entries. +* If you feel contribution is substantial enough for official author or contributor status, please add yourself as an author in the [`DESCRIPTION](https://github.com/wlandau/targets-minimal/blob/master/DESCRIPTION) file. diff --git a/DESCRIPTION b/DESCRIPTION new file mode 100644 index 0000000..ffe8447 --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,39 @@ +Package: targets.minimal +Title: Minimal Example of a Targets Pipeline +Description: Minimal example of a data analysis project with the targets + R package. +Version: 0.0.0.9000 +License: MIT + file LICENSE +URL: https://wlandau.github.io/targets-minimal, + https://github.com/wlandau/targets-minimal +BugReports: https://github.com/wlandau/targets-minimal/issues +Authors@R: c( + person( + given = c("William", "Michael"), + family = "Landau", + role = c("aut", "cre"), + email = "will.landau@gmail.com", + comment = c(ORCID = "0000-0003-1878-3253") + ), + person( + family = "Eli Lilly and Company", + role = "cph" + )) +Depends: + R (>= 3.5.0) +Imports: + biglm (>= 0.9.2), + readxl (>= 1.3.1), + rmarkdown (>= 2.3), + targets, + tidyverse (>= 1.3.0) +Suggests: + clustermq (>= 0.8.9), + visNetwork (>= 2.0.9) +Remotes: + wlandau/targets +Encoding: UTF-8 +Language: en-US +Roxygen: list(markdown = TRUE) +RoxygenNote: 7.1.0 +VignetteBuilder: knitr diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 0000000..a84824e --- /dev/null +++ b/NEWS.md @@ -0,0 +1,3 @@ +# targets.minimal 0.0.0.9000 + +* First version