Data

Tools

Indexes

Applications

Experiments

Open Source Science

planner

:package: Create ready to print calendars

https://github.com/frbcesab/planner

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.9%) to scientific vocabulary
Last synced: 8 months ago · JSON representation ·

Repository

:package: Create ready to print calendars

Basic Info
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created about 2 years ago · Last pushed about 2 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Codemeta

README.Rmd 

---
output: github_document
---




```{r, include = FALSE}
knitr::opts_chunk$set(collapse  = TRUE,
                      comment   = "#>",
                      fig.path  = "man/figures/",
                      out.width = "100%")
```



planner 
=========================================================


[![CRAN status](https://www.r-pkg.org/badges/version/planner)](https://CRAN.R-project.org/package=planner)
[![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/)






  • Overview

  • Installation

  • Get started

  • Citation

  • Contributing

  • Acknowledgments





## Overview


The R package `planner` is dedicated to create ready to print calendars. Calendars are saved as PDF files in the A4 paper format (297 x 210 mm). Users can choose between a monthly or annual calendar. Many features are available:

- choose between a full or working weeks calendar
- add holidays (available for 200+ countries)
- add special days (i.e. birthdays)
- add moon phases
- add single-day events
- add multi-day events
- add multi-week events
- add sub-calendars (event categories)
- change calendar language

![](vignettes/figures/calendar-demo-12.png)




![](vignettes/figures/calendar-demo-14.png)






## Installation

You can install the development version from [GitHub](https://github.com/) with:

```{r eval=FALSE}
## Install < remotes > package (if not already installed) ----
if (!requireNamespace("remotes", quietly = TRUE)) {
  install.packages("remotes")
}

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

Then you can attach the package `planner`:

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



## Get started

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 `planner` as: 

> Casajus Nicolas (`r format(Sys.Date(), "%Y")`) planner: An R 
package to create ready to print calendars. R package version 0.1. 




## Contributing

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

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.



## Acknowledgments

This package has been developed as part of a 
[FRB-CESAB](https://www.fondationbiodiversite.fr/en/about-the-foundation/le-cesab/) work.

Owner

  • Name: FRB CESAB
  • Login: FRBCesab
  • Kind: organization
  • Location: Montpellier, FRANCE

Citation (CITATION.cff) 

# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v1.0.0
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "planner" in publications use:'
type: software
license: GPL-2.0-or-later
title: 'planner: Create Ready to Print Calendars'
version: '0.1'
abstract: 'Creates annual, monthly, and weekly calendars as PDF files in the A4 paper
  format. Various information can be added: events, holidays, special days, moon phases,
  etc.'
authors:
- family-names: Casajus
  given-names: Nicolas
  email: nicolas.casajus@fondationbiodiversite.fr
  orcid: https://orcid.org/0000-0002-5537-5294
preferred-citation:
  type: manual
  title: 'planner: An R package to create ready to print calendars'
  authors:
  - name: Casajus Nicolas
  year: '2024'
  notes: R package version 0.1
  url: https://github.com/frbcesab/planner/
repository-code: https://github.com/frbcesab/planner
url: https://github.com/frbcesab/planner
contact:
- family-names: Casajus
  given-names: Nicolas
  email: nicolas.casajus@fondationbiodiversite.fr
  orcid: https://orcid.org/0000-0002-5537-5294
references:
- type: software
  title: graphics
  abstract: 'R: A Language and Environment for Statistical Computing'
  notes: Imports
  authors:
  - name: R Core Team
  institution:
    name: R Foundation for Statistical Computing
    address: Vienna, Austria
  year: '2024'
- type: software
  title: grDevices
  abstract: 'R: A Language and Environment for Statistical Computing'
  notes: Imports
  authors:
  - name: R Core Team
  institution:
    name: R Foundation for Statistical Computing
    address: Vienna, Austria
  year: '2024'
- type: software
  title: httr
  abstract: 'httr: Tools for Working with URLs and HTTP'
  notes: Imports
  url: https://httr.r-lib.org/
  repository: https://CRAN.R-project.org/package=httr
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  year: '2024'
- type: software
  title: jpeg
  abstract: 'jpeg: Read and write JPEG images'
  notes: Imports
  url: https://www.rforge.net/jpeg/
  repository: https://CRAN.R-project.org/package=jpeg
  authors:
  - family-names: Urbanek
    given-names: Simon
    email: Simon.Urbanek@r-project.org
  year: '2024'
- type: software
  title: png
  abstract: 'png: Read and write PNG images'
  notes: Imports
  url: http://www.rforge.net/png/
  repository: https://CRAN.R-project.org/package=png
  authors:
  - family-names: Urbanek
    given-names: Simon
    email: Simon.Urbanek@r-project.org
  year: '2024'
- type: software
  title: rvest
  abstract: 'rvest: Easily Harvest (Scrape) Web Pages'
  notes: Imports
  url: https://rvest.tidyverse.org/
  repository: https://CRAN.R-project.org/package=rvest
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  year: '2024'
- type: software
  title: tools
  abstract: 'R: A Language and Environment for Statistical Computing'
  notes: Imports
  authors:
  - name: R Core Team
  institution:
    name: R Foundation for Statistical Computing
    address: Vienna, Austria
  year: '2024'
- type: software
  title: utils
  abstract: 'R: A Language and Environment for Statistical Computing'
  notes: Imports
  authors:
  - name: R Core Team
  institution:
    name: R Foundation for Statistical Computing
    address: Vienna, Austria
  year: '2024'
- type: software
  title: knitr
  abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
  notes: Suggests
  url: https://yihui.org/knitr/
  repository: https://CRAN.R-project.org/package=knitr
  authors:
  - family-names: Xie
    given-names: Yihui
    email: xie@yihui.name
    orcid: https://orcid.org/0000-0003-0645-5666
  year: '2024'
- type: software
  title: rmarkdown
  abstract: 'rmarkdown: Dynamic Documents for R'
  notes: Suggests
  url: https://pkgs.rstudio.com/rmarkdown/
  repository: https://CRAN.R-project.org/package=rmarkdown
  authors:
  - family-names: Allaire
    given-names: JJ
    email: jj@posit.co
  - family-names: Xie
    given-names: Yihui
    email: xie@yihui.name
    orcid: https://orcid.org/0000-0003-0645-5666
  - family-names: Dervieux
    given-names: Christophe
    email: cderv@posit.co
    orcid: https://orcid.org/0000-0003-4474-2498
  - family-names: McPherson
    given-names: Jonathan
    email: jonathan@posit.co
  - family-names: Luraschi
    given-names: Javier
  - family-names: Ushey
    given-names: Kevin
    email: kevin@posit.co
  - family-names: Atkins
    given-names: Aron
    email: aron@posit.co
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  - family-names: Cheng
    given-names: Joe
    email: joe@posit.co
  - family-names: Chang
    given-names: Winston
    email: winston@posit.co
  - family-names: Iannone
    given-names: Richard
    email: rich@posit.co
    orcid: https://orcid.org/0000-0003-3925-190X
  year: '2024'

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "planner",
  "description": "Creates annual, monthly, and weekly calendars as PDF files in the A4 paper format. Various information can be added: events, holidays, special days, moon phases, etc.",
  "name": "planner: Create Ready to Print Calendars",
  "codeRepository": "https://github.com/frbcesab/planner",
  "issueTracker": "https://github.com/frbcesab/planner/issues",
  "license": "https://spdx.org/licenses/GPL-2.0",
  "version": "0.1",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.3.3 (2024-02-29 ucrt)",
  "author": [
    {
      "@type": "Person",
      "givenName": "Nicolas",
      "familyName": "Casajus",
      "email": "nicolas.casajus@fondationbiodiversite.fr",
      "@id": "https://orcid.org/0000-0002-5537-5294"
    }
  ],
  "copyrightHolder": [
    {
      "@type": "Person",
      "givenName": "Nicolas",
      "familyName": "Casajus",
      "email": "nicolas.casajus@fondationbiodiversite.fr",
      "@id": "https://orcid.org/0000-0002-5537-5294"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Nicolas",
      "familyName": "Casajus",
      "email": "nicolas.casajus@fondationbiodiversite.fr",
      "@id": "https://orcid.org/0000-0002-5537-5294"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "graphics",
      "name": "graphics"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "grDevices",
      "name": "grDevices"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "httr",
      "name": "httr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=httr"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "jpeg",
      "name": "jpeg",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=jpeg"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "png",
      "name": "png",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=png"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "rvest",
      "name": "rvest",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rvest"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "tools",
      "name": "tools"
    },
    "8": {
      "@type": "SoftwareApplication",
      "identifier": "utils",
      "name": "utils"
    },
    "SystemRequirements": null
  },
  "fileSize": "1272.626KB",
  "citation": [
    {
      "@type": "SoftwareSourceCode",
      "datePublished": "2024",
      "author": [
        {
          "@type": "Organization",
          "name": "Casajus Nicolas"
        }
      ],
      "name": "planner: {An} {R} package to create ready to print calendars",
      "url": "https://github.com/frbcesab/planner/",
      "description": "R package version 0.1"
    }
  ],
  "releaseNotes": "https://github.com/frbcesab/planner/blob/master/NEWS.md",
  "readme": "https://github.com/FRBCesab/planner/blob/main/README.md",
  "contIntegration": [
    "https://github.com/frbcesab/planner/actions/workflows/R-CMD-check.yaml",
    "https://github.com/frbcesab/planner/actions/workflows/pkgdown.yaml"
  ]
}

GitHub Events

Total
Last Year

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 77
  • Total Committers: 1
  • Avg Commits per committer: 77.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 77
  • Committers: 1
  • Avg Commits per committer: 77.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Nicolas Casajus a****s 77

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 2
  • Total pull requests: 0
  • Average time to close issues: about 16 hours
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 0
  • Average time to close issues: about 16 hours
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • ahasverus (2)
Pull Request Authors
Top Labels
Issue Labels
enhancement (1) bug (1)
Pull Request Labels

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/update-citation-cff.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran