Skip to content

Commit

Permalink
BREAKING CHANGE: rename package
Browse files Browse the repository at this point in the history
  • Loading branch information
ahasverus committed Apr 3, 2024
1 parent 2389f3e commit f578237
Show file tree
Hide file tree
Showing 20 changed files with 266 additions and 100 deletions.
40 changes: 20 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to calendar
# Contributing to planner

First off, thanks for taking the time to contribute to `calendar`!
First off, thanks for taking the time to contribute to `planner`!

All types of contributions are encouraged and valued. See the
[Table of contents](#table-of-contents) for different ways to help and details
Expand All @@ -25,7 +25,7 @@ maintainers and smooth out the experience for all involved.
## Code of conduct

This project is released with a
[Contributor Code of Conduct](https://github.com/ahasverus/calendar/blob/main/CODE_OF_CONDUCT.md).
[Contributor Code of Conduct](https://github.com/frbcesab/planner/blob/main/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report
unacceptable behavior to <[email protected]>.

Expand All @@ -36,7 +36,7 @@ unacceptable behavior to <[email protected]>.
We use the [Tidyverse style guide](https://style.tidyverse.org/) for writing R
code. Functions are documented with the
[roxygen2](https://roxygen2.r-lib.org/articles/roxygen2.html) syntax.
`calendar` uses the `lower_snake_case`.
`planner` uses the `lower_snake_case`.



Expand All @@ -51,15 +51,15 @@ specification.
## Asking questions

Before you ask a question, it is best to search for existing
[Issues](https://github.com/ahasverus/calendar/issues) that might help
[Issues](https://github.com/frbcesab/planner/issues) that might help
you. In case you have found a suitable issue and still need clarification, you
can write your question in this issue.

If you then still feel the need to ask a question and need clarification, we
recommend the following:

- Open a new [Issue](https://github.com/ahasverus/calendar/issues/new).
- Use the template [other_issue.md](https://github.com/ahasverus/calendar/blob/main/.github/ISSUE_TEMPLATE/other_issue.md).
- Open a new [Issue](https://github.com/frbcesab/planner/issues/new).
- Use the template [other_issue.md](https://github.com/frbcesab/planner/blob/main/.github/ISSUE_TEMPLATE/other_issue.md).
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (paste the output of `sessionInfo()`).

Expand All @@ -78,21 +78,21 @@ information. Therefore, we ask you to investigate carefully, collect information
and describe the issue in detail in your report. Please complete the following
steps in advance to help us fix any potential bug as fast as possible.

- Make sure that you are using the latest version of `calendar`.
- Make sure that you are using the latest version of `planner`.
- Determine if your bug is really a bug and not an error on your side.
- To see if other users have experienced (and potentially already solved) the
same issue you are having, check if there is not already a bug report existing
for your bug or error in the [bug tracker](https://github.com/ahasverus/calendar/issues?q=label%3Abug).
for your bug or error in the [bug tracker](https://github.com/frbcesab/planner/issues?q=label%3Abug).



### How do I submit a bug report?

We use [GitHub Issues](https://github.com/ahasverus/calendar/issues) to
We use [GitHub Issues](https://github.com/frbcesab/planner/issues) to
track bugs and errors. If you run into an issue with the project:

- Open a new [Issue](https://github.com/ahasverus/calendar/issues/new).
- Use the template [bug_report.md](https://github.com/ahasverus/calendar/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).
- Open a new [Issue](https://github.com/frbcesab/planner/issues/new).
- Use the template [bug_report.md](https://github.com/frbcesab/planner/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the
*reproduction steps* that someone else can follow to recreate the issue on
Expand All @@ -108,10 +108,10 @@ We will then take care of the issue as soon as possible.

### Before requesting a feature

- Make sure that you are using the latest version of `calendar`.
- Read the [documentation](https://github.com/ahasverus/calendar/)
- Make sure that you are using the latest version of `planner`.
- Read the [documentation](https://github.com/frbcesab/planner/)
carefully and find out if the functionality is already covered.
- Perform a [search](https://github.com/ahasverus/calendar/issues) to
- Perform a [search](https://github.com/frbcesab/planner/issues) to
see if this enhancement has already been suggested. If it has, add a comment to
the existing issue instead of opening a new one.

Expand All @@ -120,14 +120,14 @@ the existing issue instead of opening a new one.
### How do I submit a feature request?

Feature requests are tracked as
[GitHub Issues](https://github.com/ahasverus/calendar/issues).
[GitHub Issues](https://github.com/frbcesab/planner/issues).

- Open a new [Issue](https://github.com/ahasverus/calendar/issues/new).
- Use the template [feature_request.md](https://github.com/ahasverus/calendar/blob/main/.github/ISSUE_TEMPLATE/feature_request.md).
- Open a new [Issue](https://github.com/frbcesab/planner/issues/new).
- Use the template [feature_request.md](https://github.com/frbcesab/planner/blob/main/.github/ISSUE_TEMPLATE/feature_request.md).
- Provide a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as
many details as possible.
- Explain why this enhancement would be useful to most `calendar` users.
- Explain why this enhancement would be useful to most `planner` users.

We will then take care of the issue as soon as possible.

Expand All @@ -153,7 +153,7 @@ by the name of your new branch).
1. Make your contribution (see below for examples).
1. Stage (`git add`) and commit (`git commit`) your changes as often as necessary
1. Push your changes to GitHub w/ `git push origin branch-name`.
3. Submit a [Pull Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request) on the [original repo](https://github.com/ahasverus/calendar/compare).
3. Submit a [Pull Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request) on the [original repo](https://github.com/frbcesab/planner/compare).

We will then review the PR as soon as possible.

Expand Down
6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Package: calendar
Package: planner
Type: Package
Title: Create a Monthly Calendar with Events
Version: 0.0.0.9000
Expand All @@ -12,8 +12,8 @@ Description: Plots and exports a monthly calendar as 'pdf'. Holidays (France
only) are identified. User can easily add events (up to four by day) and
choose between of a week of five days (working week) or a full week
(weekend included).
URL: https://github.com/frbcesab/calendar
BugReports: https://github.com/frbcesab/calendar/issues
URL: https://github.com/frbcesab/planner
BugReports: https://github.com/frbcesab/planner/issues
License: GPL (>= 2)
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# calendar 0.0.0.9000 (development version)
# planner 0.0.0.9000 (development version)
2 changes: 1 addition & 1 deletion R/multiweek_events.R
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ multiweek_events <- function(data, year, month, weekend) {
events <- rbind(events, days)
}

events <- events[with(events, order(from, -n_days, name)), ]
events <- events[with(events, order(from, -n_days, to, name)), ]

rownames(events) <- NULL
}
Expand Down
30 changes: 15 additions & 15 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ knitr::opts_chunk$set(collapse = TRUE,



calendar <img src="man/figures/logo.png" align="right" style="float:right; height:120px;"/>
planner <img src="man/figures/logo.png" align="right" style="float:right; height:120px;"/>
=========================================================

<!-- badges: start -->
[![R CMD Check](https://github.com/frbcesab/calendar/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/frbcesab/calendar/actions/workflows/R-CMD-check.yaml)
[![Website](https://github.com/frbcesab/calendar/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/frbcesab/calendar/actions/workflows/pkgdown.yaml)
[![R CMD Check](https://github.com/frbcesab/planner/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/frbcesab/planner/actions/workflows/R-CMD-check.yaml)
[![Website](https://github.com/frbcesab/planner/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/frbcesab/planner/actions/workflows/pkgdown.yaml)
[![License: GPL (>= 2)](https://img.shields.io/badge/License-GPL%20%28%3E%3D%202%29-blue.svg)](https://choosealicense.com/licenses/gpl-2.0/)
<!-- badges: end -->

Expand All @@ -39,7 +39,7 @@ calendar <img src="man/figures/logo.png" align="right" style="float:right; heigh
## Overview


The R package `calendar` is dedicated to create a monthly calendar. It plots and exports the calendar as a `pdf` file (ready to print in the A4 paper format). Holidays (only France is supported yet) are identified and user can easily add events (up to four by day). User can also choose between of a week of five days (working week) or a full week (weekend included).
The R package `planner` is dedicated to create a monthly calendar. It plots and exports the calendar as a `pdf` file (ready to print in the A4 paper format). Holidays (only France is supported yet) are identified and user can easily add events (up to four by day). User can also choose between of a week of five days (working week) or a full week (weekend included).


- **Empty monthly calendar (with weekends)**
Expand Down Expand Up @@ -87,42 +87,42 @@ if (!requireNamespace("remotes", quietly = TRUE)) {
install.packages("remotes")
}
## Install < calendar > from GitHub ----
remotes::install_github("frbcesab/calendar")
## Install < planner > from GitHub ----
remotes::install_github("frbcesab/planner")
```

Then you can attach the package `calendar`:
Then you can attach the package `planner`:

```{r eval=FALSE}
library("calendar")
library("planner")
```



## Get started

For an overview of the main features of `calendar`, please read the
[Get started](https://frbcesab.github.io/calendar/articles/calendar.html)
For an overview of the main features of `planner`, please read the
[Get started](https://frbcesab.github.io/planner/articles/planner.html)
vignette.



## Citation

Please cite `calendar` as:
Please cite `planner` as:

> Casajus Nicolas (`r format(Sys.Date(), "%Y")`) calendar: An R
> Casajus Nicolas (`r format(Sys.Date(), "%Y")`) planner: An R
package to create a monthly calendar. R package version 0.0.0.9000.
<https://github.com/frbcesab/calendar/>
<https://github.com/frbcesab/planner/>



## Contributing

All types of contributions are encouraged and valued. For more information,
check out our [Contributor Guidelines](https://github.com/frbcesab/calendar/blob/main/CONTRIBUTING.md).
check out our [Contributor Guidelines](https://github.com/frbcesab/planner/blob/main/CONTRIBUTING.md).

Please note that the `calendar` project is released with a
Please note that the `planner` project is released with a
[Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.

Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# calendar <img src="man/figures/logo.png" align="right" style="float:right; height:120px;"/>
# planner <img src="man/figures/logo.png" align="right" style="float:right; height:120px;"/>

<!-- badges: start -->

[![R CMD
Check](https://github.com/frbcesab/calendar/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/frbcesab/calendar/actions/workflows/R-CMD-check.yaml)
[![Website](https://github.com/frbcesab/calendar/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/frbcesab/calendar/actions/workflows/pkgdown.yaml)
Check](https://github.com/frbcesab/planner/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/frbcesab/planner/actions/workflows/R-CMD-check.yaml)
[![Website](https://github.com/frbcesab/planner/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/frbcesab/planner/actions/workflows/pkgdown.yaml)
[![License: GPL (\>=
2)](https://img.shields.io/badge/License-GPL%20%28%3E%3D%202%29-blue.svg)](https://choosealicense.com/licenses/gpl-2.0/)
<!-- badges: end -->
Expand All @@ -23,7 +23,7 @@ Check](https://github.com/frbcesab/calendar/actions/workflows/R-CMD-check.yaml/b

## Overview

The R package `calendar` is dedicated to create a monthly calendar. It
The R package `planner` is dedicated to create a monthly calendar. It
plots and exports the calendar as a `pdf` file (ready to print in the A4
paper format). Holidays (only France is supported yet) are identified
and user can easily add events (up to four by day). User can also choose
Expand Down Expand Up @@ -75,37 +75,37 @@ if (!requireNamespace("remotes", quietly = TRUE)) {
install.packages("remotes")
}

## Install < calendar > from GitHub ----
remotes::install_github("frbcesab/calendar")
## Install < planner > from GitHub ----
remotes::install_github("frbcesab/planner")
```

Then you can attach the package `calendar`:
Then you can attach the package `planner`:

``` r
library("calendar")
library("planner")
```

## Get started

For an overview of the main features of `calendar`, please read the [Get
started](https://frbcesab.github.io/calendar/articles/calendar.html)
For an overview of the main features of `planner`, please read the [Get
started](https://frbcesab.github.io/planner/articles/planner.html)
vignette.

## Citation

Please cite `calendar` as:
Please cite `planner` as:

> Casajus Nicolas (2024) calendar: An R package to create a monthly
> Casajus Nicolas (2024) planner: An R package to create a monthly
> calendar. R package version 0.0.0.9000.
> <https://github.com/frbcesab/calendar/>
> <https://github.com/frbcesab/planner/>
## Contributing

All types of contributions are encouraged and valued. For more
information, check out our [Contributor
Guidelines](https://github.com/frbcesab/calendar/blob/main/CONTRIBUTING.md).
Guidelines](https://github.com/frbcesab/planner/blob/main/CONTRIBUTING.md).

Please note that the `calendar` project is released with a [Contributor
Please note that the `planner` project is released with a [Contributor
Code of
Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.
Expand Down
2 changes: 1 addition & 1 deletion _pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
url: https://frbcesab.github.io/calendar
url: https://frbcesab.github.io/planner

template:
bootstrap: 5
25 changes: 9 additions & 16 deletions codemeta.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"identifier": "calendar",
"identifier": "planner",
"description": "Plots and exports a monthly calendar as 'pdf'. Holidays (France only) are identified. User can easily add events (up to four by day) and choose between of a week of five days (working week) or a full week (weekend included).",
"name": "calendar: Create a Monthly Calendar with Events",
"codeRepository": "https://github.com/frbcesab/calendar",
"issueTracker": "https://github.com/frbcesab/calendar/issues",
"name": "planner: Create a Monthly Calendar with Events",
"codeRepository": "https://github.com/frbcesab/planner",
"issueTracker": "https://github.com/frbcesab/planner/issues",
"license": "https://spdx.org/licenses/GPL-2.0",
"version": "0.0.0.9000",
"programmingLanguage": {
Expand All @@ -14,12 +14,6 @@
"url": "https://r-project.org"
},
"runtimePlatform": "R version 4.3.3 (2024-02-29 ucrt)",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"author": [
{
"@type": "Person",
Expand Down Expand Up @@ -144,7 +138,7 @@
},
"SystemRequirements": null
},
"fileSize": "1227.48KB",
"fileSize": "1592.68KB",
"citation": [
{
"@type": "SoftwareSourceCode",
Expand All @@ -155,12 +149,11 @@
"name": "Casajus Nicolas"
}
],
"name": "calendar: {An} {R} package to create a monthly calendar",
"url": "https://github.com/frbcesab/calendar",
"name": "planner: {An} {R} package to create a monthly calendar",
"url": "https://github.com/frbcesab/planner/",
"description": "R package version 0.0.0.9000"
}
],
"releaseNotes": "https://github.com/frbcesab/calendar/blob/master/NEWS.md",
"readme": "https://github.com/FRBCesab/calendar/blob/main/README.md",
"contIntegration": ["https://github.com/frbcesab/calendar/actions/workflows/R-CMD-check.yaml", "https://github.com/frbcesab/calendar/actions/workflows/pkgdown.yaml"]
"releaseNotes": "https://github.com/frbcesab/planner/blob/master/NEWS.md",
"contIntegration": ["https://github.com/frbcesab/planner/actions/workflows/R-CMD-check.yaml", "https://github.com/frbcesab/planner/actions/workflows/pkgdown.yaml"]
}
4 changes: 2 additions & 2 deletions inst/CITATION
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ citHeader("To cite calendar in publications use:")

bibentry(
bibtype = "Manual",
title = "calendar: {An} {R} package to create a monthly calendar",
title = "planner: {An} {R} package to create a monthly calendar",
author = c(person("Casajus Nicolas")),
year = "2024",
note = "R package version 0.0.0.9000",
url = "https://github.com/frbcesab/calendar"
url = "https://github.com/frbcesab/planner/"
)
4 changes: 2 additions & 2 deletions inst/package-sticker/package-sticker.R
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ p <- ggplot2::ggplot() +
hexSticker::sticker(

subplot = p,
package = "calendar",
package = "planner",
filename = here::here("man", "figures", "logo.png"),
dpi = 600,

Expand All @@ -39,7 +39,7 @@ hexSticker::sticker(
s_width = 1.25, # Subplot
s_height = 1.25, # Subplot

url = "https://frbcesab.github.io/calendar",
url = "https://frbcesab.github.io/planner/",

spotlight = TRUE,
l_alpha = 0.10,
Expand Down
Binary file modified man/figures/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit f578237

Please sign in to comment.