-
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.
Drafted the package based on the Bioc templates.
- Loading branch information
1 parent
9f73fd1
commit cdb8919
Showing
30 changed files
with
1,442 additions
and
14 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,3 +1,6 @@ | ||
^changchang\.Rproj$ | ||
^\.Rproj\.user$ | ||
^dev$ | ||
^.*\.Rproj$ | ||
^\.Rproj\.user$ | ||
^README.Rmd$ | ||
^pkgdown$ | ||
^\.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 @@ | ||
*.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,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 `changchang` 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 `changchang` 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. | ||
|
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,64 @@ | ||
# Getting help with `changchang` | ||
|
||
Thank you for using `changchang`! | ||
Before filing an issue, there are few things you should know to make the process | ||
as smooth as possible for both parties. | ||
|
||
## Make a reprex | ||
|
||
Start by making a minimally **repr**oducible **ex**ample, also known as a | ||
'reprex'. You may use the [`reprex`](https://reprex.tidyverse.org/) R package to | ||
create one, though it is not necessary but it does help. It will make all of | ||
your R-question-asking endeavors easier. Learning | ||
[how to use it](https://reprex.tidyverse.org/articles/learn-reprex.html) takes | ||
about 5 to 10 minutes. | ||
|
||
For more tips on how to make a minimally **repr**oducible **ex**ample, see this | ||
[StackOverflow link](https://stackoverflow.com/questions/5963269/how-to-make-a-great-r-reproducible-example). | ||
|
||
## Where to post it? | ||
|
||
The [Bioconductor help](http://bioconductor.org/help/) web page gives an | ||
overview of places that may help answer your question. | ||
|
||
* Bioconductor software related questions, such as bug reports and feature | ||
requests, should be addressed in the appropriate `Bioconductor/changchang` | ||
GitHub repository. Follow our bug report and feature request templates on | ||
GitHub. If the package does not have a GitHub repository, see the next bullet | ||
point. | ||
|
||
* Bioconductor software usage questions should be addressed in the | ||
[Bioconductor Support Website](https://support.bioconductor.org/). Make sure | ||
to use the | ||
[appropriate package tag](https://support.bioconductor.org/tag/changchang), | ||
otherwise the package authors will not get a notification. | ||
|
||
* General R questions can be posed at StackOverflow or at the | ||
[RStudio Community](https://community.rstudio.com/) website especially if they | ||
pertain to the `tidyverse` or the RStudio GUI or related products. | ||
|
||
## Issues or Feature Requests | ||
|
||
Before opening a new issue or feature request, be sure to | ||
[search issues and pull requests](/~https://github.com//issues) | ||
to ensure that one does not already exist or has been implemented in the | ||
development version. | ||
|
||
**Note**. You can remove the `is:open` search term in the issues page to search | ||
through open and closed issues. See | ||
[this link to learn more](https://help.github.com/articles/searching-issues-and-pull-requests/) | ||
about modifying the search. | ||
|
||
## What happens next? | ||
|
||
Our Bioconductor maintainers are limited in resources but they do strive to be | ||
as responsive as possible. | ||
|
||
Please do not forget to tag the appropriate maintainer in the issue with their | ||
GitHub username (e.g., @username). | ||
|
||
In order to make it easy as possible for Bioconductor core developers to | ||
remediate the issue. Provide an accurate, brief, and reproducible report | ||
as outlined in the issue templates. | ||
|
||
Thank you for trusting Bioconductor. |
Oops, something went wrong.