Skip to content

Commit

Permalink
Finish Release-v0.1.5
Browse files Browse the repository at this point in the history
  • Loading branch information
franzbischoff committed May 26, 2021
2 parents 57a3379 + a9b4e14 commit 2895185
Show file tree
Hide file tree
Showing 42 changed files with 1,615 additions and 457 deletions.
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
^renv$
^renv\.lock$
^\.history$
^\.vscode$
^\.editorconfig$
^.*\.code-workspace$
Expand Down Expand Up @@ -35,3 +36,4 @@
\.clang-format
^Makefile$
^docs/_pkgdown\.yml$
^.*\.tex$
88 changes: 51 additions & 37 deletions .Rprofile
Original file line number Diff line number Diff line change
@@ -1,47 +1,61 @@
# nolint start
source("renv/activate.R")

a <- try(suppressWarnings(source(file.path(
Sys.getenv(if (.Platform$OS.type == "windows") {
"USERPROFILE"
} else {
"HOME"
}),
".vscode-R",
"init.R"
))),
silent = TRUE
)
if (Sys.getenv("CI") == "") { # not CI

rm(a)
if (Sys.getenv("RSTUDIO") == "") {
suppressMessages(if (requireNamespace("languageserver")) {
a <- try(suppressWarnings(source(file.path(
Sys.getenv(if (.Platform$OS.type == "windows") {
"USERPROFILE"
} else {
"HOME"
}),
".vscode-R",
"init.R"
))),
silent = TRUE
)

if (interactive()) {
suppressMessages(suppressWarnings(require(testthat)))
suppressMessages(require(devtools))
suppressMessages(require(usethis))
suppressMessages(require(conflicted))
# suppressMessages(prettycode::prettycode())
rm(a)
})
}

options(
warnPartialMatchArgs = FALSE,
warnPartialMatchDollar = FALSE,
warnPartialMatchAttr = FALSE,
usethis.protocol = "https"
# error = recover
)
if (interactive()) {
options(
warnPartialMatchArgs = FALSE,
warnPartialMatchDollar = FALSE,
warnPartialMatchAttr = FALSE,
usethis.protocol = "https",
vsc.rstudioapi = TRUE
# error = recover
)

suppressMessages(
suppressWarnings({
require("testthat", quietly = TRUE)
require("devtools", quietly = TRUE)
require("usethis", quietly = TRUE)
require("conflicted", quietly = TRUE)
require("here", quietly = TRUE)
})
)
# suppressMessages(prettycode::prettycode())

suppressMessages(if (requireNamespace("prompt")) {
prompt::set_prompt(function(...) {
paste0(
"[",
prompt::git_branch(),
prompt::git_dirty(),
prompt::git_arrows(),
"] ",
prompt::prompt_runtime()
)
})
})
if (suppressMessages(requireNamespace("prompt", quietly = TRUE))) {
prompt::set_prompt(function(...) {
paste0(
"[",
prompt::git_branch(),
prompt::git_dirty(),
prompt::git_arrows(),
"] ",
prompt::prompt_runtime()
)
})
}
}
} else { # is CI
message("Running .RProfile in CI")
}
# nolint end
27 changes: 13 additions & 14 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or
- The use of sexualized language or imagery, and sexual attention or
advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand All @@ -59,8 +59,7 @@ representative at an online or offline event.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at [INSERT CONTACT
METHOD]. All complaints will be reviewed and investigated promptly and fairly.
reported to the community leaders responsible for enforcement at [Matrix Profile Foundation](https://matrixprofile.org/). All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
Expand Down Expand Up @@ -115,7 +114,7 @@ community.

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0,
available at https://www.contributor-covenant.org/version/2/0/
available at <https://www.contributor-covenant.org/version/2/0/>
code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
Expand All @@ -124,5 +123,5 @@ enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at https://
<https://www.contributor-covenant.org/faq>. Translations are available at https://
www.contributor-covenant.org/translations.
21 changes: 11 additions & 10 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Contributing to matrixprofiler

This outlines how to propose a change to matrixprofiler.
For more detailed info about contributing to this, and other tidyverse packages, please see the
[**development contributing guide**](https://rstd.io/tidy-contrib).
For more detailed info about contributing, please see the
[**development contributing guide**](https://rstd.io/tidy-contrib) from tidyverse as we pretty sure
align with that.

## Fixing typos

Expand All @@ -18,26 +19,26 @@ If you’ve found a bug, please file an issue that illustrates the bug with a mi

### 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("matrix-profile-foundation/matrixprofiler", fork = TRUE)`.
- Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("matrix-profile-foundation/matrixprofiler", fork = TRUE)`.

- Install all development dependences with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`.
- Install all development dependences 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")`.
- 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.
- 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>.
- 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).
- 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 [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.
- 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
Expand Down
11 changes: 8 additions & 3 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
Please briefly describe your problem and what output you expect. If you have a question, please don't use this form. Instead, ask on <https://stackoverflow.com/> or <https://community.rstudio.com/>.
---
name: Bug report or feature request
about: Describe a bug you've seen or make a case for a new feature
---

Please include a minimal reproducible example (AKA a reprex). If you've never heard of a [reprex](https://reprex.tidyverse.org/) before, start by reading <https://www.tidyverse.org/help/#reprex>.
# My issue title

---
Please briefly describe your problem and what output you expect. If you have a question, please don't use this form. Instead, ask on <https://matrixprofile.org/>.

Please include a minimal reproducible example (AKA a reprex). If you've never heard of a [reprex](http://reprex.tidyverse.org/) before, start by reading <https://www.tidyverse.org/help/#reprex>.

Brief description of the problem

Expand Down
4 changes: 3 additions & 1 deletion .github/ISSUE_TEMPLATE/issue_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ name: Bug report or feature request
about: Describe a bug you've seen or make a case for a new feature
---

Please briefly describe your problem and what output you expect. If you have a question, please don't use this form. Instead, ask on <https://stackoverflow.com/> or <https://community.rstudio.com/>.
# My issue title

Please briefly describe your problem and what output you expect. If you have a question, please don't use this form. Instead, ask on <https://matrixprofile.org/>.

Please include a minimal reproducible example (AKA a reprex). If you've never heard of a [reprex](http://reprex.tidyverse.org/) before, start by reading <https://www.tidyverse.org/help/#reprex>.

Expand Down
16 changes: 9 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Prework
# My Pull Request Title

* [ ] I understand and agree to the [code of conduct](https://github.com/wlandau/targets/blob/main/CODE_OF_CONDUCT.md) and the [contributing guidelines](https://github.com/wlandau/targets/blob/main/CONTRIBUTING.md).
* [ ] I have already submitted an issue to the [issue tracker](http://github.com/wlandau/targets/issues) to discuss my idea with the maintainer.
* [ ] This pull request is not a [draft](https://github.blog/2019-02-14-introducing-draft-pull-requests).
## Prework

# Related GitHub issues and pull requests
* [ ] I understand and agree to the [code of conduct](CODE_OF_CONDUCT.md) and the [contributing guidelines](CONTRIBUTING.md).
* [ ] I have already submitted an issue to the [issue tracker](https://github.com/matrix-profile-foundation/matrixprofiler/issues) to discuss my idea with the maintainer.
* [ ] This pull request is not a [draft](https://github.blog/2019-02-14-introducing-draft-pull-requests).

* Ref: #
## Related GitHub issues and pull requests

# Summary
* Ref: #

## Summary

Please explain the purpose and scope of your contribution.
12 changes: 6 additions & 6 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ For additional reprex pointers, check out the [Get help!](https://www.tidyverse.

## Where to ask?

Armed with your reprex, the next step is to figure out [where to ask](https://www.tidyverse.org/help/#where-to-ask).
Armed with your reprex, the next step is to figure out **where to ask**.

- If it's a question: start with [community.rstudio.com](https://community.rstudio.com/), and/or StackOverflow. There are more people there to answer questions.
- If it's a question: start with [Matrix Profile Foundation](https://matrixprofile.org/), and/or StackOverflow. There are more people there to answer questions.

- If it's a bug: you're in the right place, [file an issue](https://github.com/matrix-profile-foundation/matrixprofiler/issues/new).
- If it's a bug: you're in the right place, [file an issue](https://github.com/matrix-profile-foundation/matrixprofiler/issues/new).

- If you're not sure: let the community help you figure it out!
- If you're not sure: let the community help you figure it out!
If your problem _is_ a bug or a feature request, you can easily return here and report it.

Before opening a new issue, be sure to [search issues and pull requests](https://github.com/matrix-profile-foundation/matrixprofiler/issues) to make sure the bug hasn't been reported and/or already fixed in the development version.
Expand All @@ -29,7 +29,7 @@ For example, you'd simply remove `is:open` to search _all_ issues in the repo, o
## What happens next?

To be as efficient as possible, development of tidyverse packages tends to be very bursty, so you shouldn't worry if you don't get an immediate response.
Typically we don't look at a repo until a sufficient quantity of issues accumulates, then theres a burst of intense activity as we focus our efforts.
Typically we don't look at a repo until a sufficient quantity of issues accumulates, then there's a burst of intense activity as we focus our efforts.
That makes development more efficient because it avoids expensive context switching between problems, at the cost of taking longer to get back to you.
This process makes a good reprex particularly important because it might be multiple months between your initial report and when we start working on it.
If we cant reproduce the bug, we cant fix it!
If we can't reproduce the bug, we can't fix it!
1 change: 1 addition & 0 deletions .github/workflows/test-coverage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ jobs:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
CODECOV_TOKEN: '21b809ce-ca02-4af5-954f-0dcadb160d24'
steps:
- uses: actions/checkout@v2
- name: Install cURL and others
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,4 @@ Rplots.pdf
README.html

workspace.RData
.history
Loading

0 comments on commit 2895185

Please sign in to comment.