-
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
1 parent
6282bdd
commit 8d82713
Showing
19 changed files
with
1,088 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 |
---|---|---|
@@ -1 +1,4 @@ | ||
^dev$ | ||
^README\.Rmd$ | ||
^\.github$ | ||
^codecov\.yml$ |
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 @@ | ||
*.html |
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 @@ | ||
The Bioconductor community values | ||
|
||
* an open approach to science that promotes the sharing of ideas, code, and expertise | ||
* collaboration | ||
* diversity and inclusivity | ||
* a kind and welcoming environment | ||
* community contributions | ||
|
||
In line with these values, Bioconductor is dedicated to providing a welcoming, supportive, collegial, experience free of harassment, intimidation, and bullying regardless of: | ||
|
||
* identity: gender, gender identity and expression, sexual orientation, disability, physical appearance, ethnicity, body size, race, age, religion, etc. | ||
* intellectual position: approaches to data analysis, software preferences, coding style, scientific perspective, etc. | ||
* stage of career | ||
|
||
In order to uphold these values, members of the Bioconductor community are required to follow the Code of Conduct.The latest version of Bioconductor project Code of Conduct is available at http://bioconductor.org/about/code-of-conduct/. Please read the Code of Conduct before contributing to this project. | ||
|
||
Thank you! |
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,47 @@ | ||
# Contributing to spatialNAcUtils | ||
|
||
This outlines how to propose a change to spatialNAcUtils. | ||
For a detailed discussion on contributing to this and other tidyverse packages, please see the [development contributing guide](https://rstd.io/tidy-contrib) and our [code review principles](https://code-review.tidyverse.org/). | ||
|
||
## Fixing typos | ||
|
||
You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the _source_ file. | ||
This generally means you'll need to edit [roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R`, not a `.Rd` file. | ||
You can find the `.R` file that generates the `.Rd` by reading the comment in the first line. | ||
|
||
## Bigger changes | ||
|
||
If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed. | ||
If you’ve found a bug, please file an issue that illustrates the bug with a minimal | ||
[reprex](https://www.tidyverse.org/help/#reprex) (this will also help you write a unit test, if needed). | ||
See our guide on [how to create a great issue](https://code-review.tidyverse.org/issues/) for more advice. | ||
|
||
### Pull request process | ||
|
||
* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("LieberInstitute/spatialNAcUtils", fork = TRUE)`. | ||
|
||
* Install all development dependencies with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`. | ||
If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing. | ||
* Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`. | ||
|
||
* Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser. | ||
The title of your PR should briefly describe the change. | ||
The body of your PR should contain `Fixes #issue-number`. | ||
|
||
* For user-facing changes, add a bullet to the top of `NEWS.md` (i.e. just below the first header). Follow the style described in <https://style.tidyverse.org/news.html>. | ||
|
||
### Code style | ||
|
||
* New code should follow the tidyverse [style guide](https://style.tidyverse.org). | ||
You can use the [styler](https://CRAN.R-project.org/package=styler) package to apply these styles, but please don't restyle code that has nothing to do with your PR. | ||
|
||
* We use [roxygen2](https://cran.r-project.org/package=roxygen2), with [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html), for documentation. | ||
|
||
* We use [testthat](https://cran.r-project.org/package=testthat) for unit tests. | ||
Contributions with test cases included are easier to accept. | ||
|
||
## Code of Conduct | ||
|
||
Please note that the spatialNAcUtils project is released with a | ||
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this | ||
project you agree to abide by its terms. |
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,37 @@ | ||
--- | ||
name: Feature Request | ||
about: Suggest an idea for this package | ||
title: "[Feature Request] A short description of the feature" | ||
labels: '' | ||
assignees: '' | ||
--- | ||
|
||
Please ask questions about how to use `spatialNAcUtils` on the Bioconductor | ||
Support Site at <https://support.bioconductor.org> using the appropriate tag(s) | ||
including the one for this package. | ||
|
||
**Note**. Update the issue title to summarize the feature request. | ||
|
||
## Is the feature request related to a problem? | ||
|
||
Please provide a clear and concise description of what the problem | ||
is. Ex. I'm always frustrated when [...] | ||
|
||
## Describe the solution | ||
|
||
A clear and concise description of what you want to happen. | ||
|
||
## Describe any alternatives considered | ||
|
||
A clear and concise description of any alternative solutions or | ||
features you've considered. | ||
|
||
## Additional context | ||
|
||
Add any other context about the feature request here. You may include web links | ||
(e.g., from GitHub) to: | ||
|
||
* raw code | ||
* a commit | ||
* code inside a commit | ||
* code from an R package |
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,73 @@ | ||
--- | ||
name: Bug Report | ||
about: Describe the bug in detail | ||
title: "[BUG] A short description of the bug" | ||
labels: '' | ||
assignees: '' | ||
--- | ||
|
||
Please ask questions about how to use `spatialNAcUtils` on the | ||
[Bioconductor Support Site](https://support.bioconductor.org) using the | ||
appropriate tag(s) including the one for this package. | ||
|
||
**Note**. Update the issue title to concisely describe the bug. | ||
|
||
## Describe the bug | ||
|
||
Please provide a clear and concise description of what the bug is. | ||
|
||
### Provide a minimally reproducible example (reprex) | ||
|
||
Provide a clear and concise description of the bug. It can be easily (but not | ||
necessarily) illustrated with a minimally reproducible example using the | ||
[`reprex` package](https://reprex.tidyverse.org/articles/learn-reprex.html). | ||
|
||
For tips on creating a reprex, see this | ||
[StackOverflow link](https://stackoverflow.com/questions/5963269/how-to-make-a-great-r-reproducible-example). | ||
|
||
## Expected behavior | ||
|
||
A clear and concise description of what you expected to happen. | ||
|
||
## R Session Information | ||
|
||
Please report the output of either `sessionInfo()` or | ||
`sessioninfo::session_info()` here. | ||
|
||
<details> | ||
|
||
```R | ||
options(width = 120) | ||
## insert session info here | ||
# sessioninfo::session_info() ## provides GitHub, pandoc, and other details | ||
# sessionInfo() ## base R function in case you don't want to install sessioninfo | ||
``` | ||
|
||
</details> | ||
|
||
Indicate whether `BiocManager::valid()` returns `TRUE`. | ||
|
||
- [ ] `BiocManager::valid()` is `TRUE` | ||
|
||
**Note**. To avoid potential issues with version mixing and reproducibility, do | ||
not install packages from `GitHub`. | ||
|
||
## Additional Context | ||
|
||
Provide some additional context for the bug report. You may include web links | ||
(e.g., from GitHub) to: | ||
|
||
* raw code | ||
* a commit | ||
* code inside a commit | ||
* code from an R package | ||
|
||
## Is the package installed via bioconda? | ||
|
||
We find that [bioconda](https://bioconda.github.io/) installations can often be | ||
problematic due to the nature of the setup environment and potential for version | ||
mixing. | ||
|
||
The preferred method for installing Bioconductor software through `BiocManager` | ||
and we do not support issues related to `bioconda` installations at this time. | ||
|
Oops, something went wrong.