-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit cdb264b
Showing
18 changed files
with
561 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
^.*\.Rproj$ | ||
^\.Rproj\.user$ | ||
.github |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a report to help us improve this package | ||
title: "" | ||
labels: ["bug"] | ||
assignees: '' | ||
|
||
--- | ||
**Describe the issue** | ||
A clear and concise description of what the issue is. Please include the following in your issue report along with any explicit errors observed | ||
* Package release version | ||
* R version | ||
|
||
**To Reproduce** | ||
`Simplified input program` | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
`Output if applicable' | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
> This is a template for UCLA-CDS R package developers to create a github pull request template. Things should be adjusted for individual pipeline including: | ||
> 1. additional checklist items specific to the package | ||
> 2. a description of how testing is expected to be done | ||
> 3. a template list or table for testing results | ||
> 4. additional notes wrapped in \<!--- ---> (or \<!-- --\> for inline comments) that help PR submitters to fill in. | ||
> 5. delete this block of instructional text. | ||
<!--- Please read each of the following items and confirm by replacing the [ ] with a [ ] ---> | ||
|
||
- [ ] I have read the [code review guidelines](https://uclahs-cds.atlassian.net/wiki/spaces/BOUTROSLAB/pages/3187646/Code+Review+Guidelines) and the [code review best practice on GitHub check-list](https://uclahs-cds.atlassian.net/wiki/spaces/BOUTROSLAB/pages/3189956/Code+Review+Best+Practice+on+GitHub+-+Check+List). | ||
|
||
- [ ] The name of the branch is meaningful and well formatted following the [standards](https://uclahs-cds.atlassian.net/wiki/spaces/BOUTROSLAB/pages/3189956/Code+Review+Best+Practice+on+GitHub+-+Check+List), using \[AD_username (or 5 letters of AD if AD is too long)-\[brief_description_of_branch]. | ||
|
||
- [ ] I have set up or verified the branch protection rule following the [github standards](https://uclahs-cds.atlassian.net/wiki/spaces/BOUTROSLAB/pages/3190380/GitHub+Standards#GitHubStandards-Branchprotectionrule) before opening this pull request. | ||
|
||
- [ ] I have added the changes included in this pull request to `NEWS` under the next release version or unreleased, and updated the date. | ||
|
||
- [ ] I have updated the version number in `metadata.yaml` and `DESCRIPTION`. | ||
|
||
- [ ] Both `R CMD build` and `R CMD check` run successfully. | ||
|
||
<!--- Briefly describe the changes included in this pull request and the test cases below | ||
!--- starting with 'Closes #...' if appropriate ---> | ||
|
||
Closes #... | ||
|
||
## Testing Results | ||
|
||
### Case 1 | ||
`input code` | ||
`output` | ||
### Case 2 | ||
`input code` | ||
`output` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: CICD-base | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
branches: | ||
- main | ||
jobs: | ||
CICD-base: | ||
runs-on: ubuntu-latest | ||
|
||
timeout-minutes: 15 | ||
|
||
steps: | ||
# Checkout codebase | ||
- name: Checkout | ||
uses: actions/checkout@v2 | ||
|
||
# Run CICD-base | ||
- name: CICD-base | ||
uses: docker://ghcr.io/uclahs-cds/cicd-base:latest |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: R-CMD-check | ||
|
||
on: | ||
- push | ||
- pull_request | ||
|
||
jobs: | ||
R-CMD-check: | ||
runs-on: ubuntu-latest | ||
|
||
container: | ||
image: blcdsdockerregistry/bl-r-devel:latest | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
with: | ||
path: BoutrosLabTemplate | ||
- run: R CMD build --compact-vignettes="gs+qpdf" BoutrosLabTemplate | ||
- run: R CMD check --as-cran --run-donttest BoutrosLabTemplate_*.tar.gz |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# System files | ||
.DS_Store | ||
|
||
# R | ||
.Rhistory | ||
.Rapp.history | ||
.RData | ||
*.Rproj* | ||
.Rproj.user |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
Package: BoutrosLabTemplate | ||
Type: Package | ||
Title: What the Package Does (Title Case) | ||
Version: 0.1.0 | ||
Author: Who wrote it | ||
Maintainer: The package maintainer <yourself@somewhere.net> | ||
Description: More about what it does (maybe more than one line) | ||
Use four spaces when indenting paragraphs within the Description. | ||
Depends: | ||
R (>= 2.10) | ||
Imports: | ||
Suggests: | ||
testthat (>= 3.0.0) | ||
Config/testthat/edition: 3 | ||
License: GPL-2 | ||
Encoding: UTF-8 | ||
LazyData: true |
Oops, something went wrong.