From d6b528f6a5a60d1cfadf839d828354317c713628 Mon Sep 17 00:00:00 2001 From: ahasverus Date: Sun, 31 Mar 2024 12:29:46 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20FRBCesab?= =?UTF-8?q?/calendar@b81234cdd46b5a03f01a18a0491c2d66b11a9780=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- apple-touch-icon-120x120.png | Bin 9129 -> 9129 bytes apple-touch-icon-152x152.png | Bin 11883 -> 11883 bytes apple-touch-icon-180x180.png | Bin 14319 -> 14319 bytes apple-touch-icon-60x60.png | Bin 4380 -> 4380 bytes apple-touch-icon-76x76.png | Bin 5496 -> 5496 bytes apple-touch-icon.png | Bin 14319 -> 14319 bytes favicon-16x16.png | Bin 1189 -> 1189 bytes favicon-32x32.png | Bin 2196 -> 2196 bytes pkgdown.yml | 2 +- reference/get_moon_phases.html | 101 +++++++++++++++++++++++++++++++++ reference/index.html | 5 ++ reference/plot_calendar.html | 7 ++- search.json | 2 +- sitemap.xml | 3 + 14 files changed, 117 insertions(+), 3 deletions(-) create mode 100644 reference/get_moon_phases.html diff --git a/apple-touch-icon-120x120.png b/apple-touch-icon-120x120.png index c00819dee3d4ef30ee42e78c0de37c936a5999f6..1e952e889c9877f20ee1a5fa2fb185ddff9512bc 100644 GIT binary patch delta 64 zcmZ4KzS4a{H9L>2?3>K*-#0duDhU}HSs7UZk+y+>m4QJ6pY65DoXYZO!XJZMvnE?9 G=K}z}?-U;Z delta 64 zcmZ4KzS4a{H9LouUSDZX#KxvlB_RU~D^m+A6EkfC11kfAiw%22Cvz&xqX{p#%ldM% Hm2y4+njaJM diff --git a/apple-touch-icon-152x152.png b/apple-touch-icon-152x152.png index 57040268ccee4340843198cb4f89c5cddf618a46..f870c05f67f233141ec960cee28dc2859509ba56 100644 GIT binary patch delta 64 zcmaDI^EzfiH9L>2Txr5G-;GV?xk1iISeaT_nV4%E7+4t?lz-p$aPnzgc{E|RReZ6N I|LEoe01~2JX89#+Z&s9n+X{jSs7Vc85?RF7+4t?)O#1}Pxd#LM-%1~J3V=F HgLysxw-*zx delta 64 zcmaE#|2}_0H9Lou{?DR4=QcL&HWM2%7+4t?s8yOJO|B7;M-vWL>AN?1 Htw25idnFSP delta 64 zcmbQEG)HMdH9Louu6WJeM;n`7@CzAOSeaT_nV4!D7+4t?JjhsnVseduJeu%CQ~8p~ HYX$NFwI38& diff --git a/apple-touch-icon-76x76.png b/apple-touch-icon-76x76.png index 7fe772139dee07437e501d8288ea6dff56d3751c..38ac839dc3add2259ba37e4ff574d8f241718764 100644 GIT binary patch delta 64 zcmeyN^+RhyH9L>2?3>K*-#0e7hzJ=PSs7UZk+y+>m4QJ6pY65DH$>#ogg*wiW=-Z4 G%?AM8;}pdJ delta 64 zcmeyN^+RhyH9LouUSDZX#KtBU5g`K$D^m+A6EkfC11kfAiw%22C*Kf}M-yIfm-Xdj HPSJb-x)T(c diff --git a/apple-touch-icon.png b/apple-touch-icon.png index 311e1998f16cffc54fbdd516f7736f989ffe8a67..5c2ce9ad7da206f6b846dd16cee9acc93f78ceef 100644 GIT binary patch delta 64 zcmaE#|2}_0H9L>2JX89#+Z&s9n+X{jSs7Vc85?RF7+4t?)O#1}Pxd#LM-%1~J3V=F HgLysxw-*zx delta 64 zcmaE#|2}_0H9LouK}pp{>y1sj&4dgrtV}JeOf0kw46Fva~Wb(Kax!GBD6Bj_H`p$|8>@9HaNd JWU?7cJ^*cl5wZXP delta 66 zcmZ3=xs-FmJ|=b!E91At4;nWgWzu65GO(~R1tLRj0|P4qgB!igu9I0=2vM$G~n2k*d?9PTpRz{Xq#-`c^237_J-7MiY3=9maC9V-ADTyVi iR=N2pnQ4^_Mg~SEx(3F&#)cuN8h%B-Zfw8W!VF;>*85W8ulT|tL0h~-31poj5 diff --git a/pkgdown.yml b/pkgdown.yml index 1fc8276..651d781 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -3,7 +3,7 @@ pkgdown: 2.0.7 pkgdown_sha: ~ articles: calendar: calendar.html -last_built: 2024-03-31T08:58Z +last_built: 2024-03-31T12:29Z urls: reference: https://frbcesab.github.io/calendar/reference article: https://frbcesab.github.io/calendar/articles diff --git a/reference/get_moon_phases.html b/reference/get_moon_phases.html new file mode 100644 index 0000000..44be2e5 --- /dev/null +++ b/reference/get_moon_phases.html @@ -0,0 +1,101 @@ + +Get moon phases for a given year — get_moon_phases • calendar + Skip to contents + + +
+
+
+

Get moon phases for a given year

+ Source: R/get_moon_phases.R +
get_moon_phases.Rd
+
+ +
+

Scraps the site https://www.timeanddate.com to retrive moon phases data.

+
+ +
+

Usage

+ 
get_moon_phases(year)
+
+ +
+

Arguments

+
year
+

either an integer or a character of length 1. Must have 4 +characters (e.g. '2024' and not '24'). Default is the current year.

+ +
+
+

Value

+ + +

A data.frame with the following columns:

  • new_moon: the date of new moons (YYYY-MM-DD),

    • +

  • full_moon: the date of full moons (integer).

    • +
+ +
+

Examples

+ 
## Get moon phases for 2024 ----
+get_moon_phases(2024)
+#> Error in `$<-.data.frame`(`*tmp*`, "new_moon", value = " 2024"): replacement has 1 row, data has 0
+
+
+
+ + +
+

Developed by Nicolas Casajus.

+
+ +
+

Site built with pkgdown 2.0.7.

+
+ +
+ + + + + + + diff --git a/reference/index.html b/reference/index.html index f36b3dc..5dfa460 100644 --- a/reference/index.html +++ b/reference/index.html @@ -74,6 +74,11 @@

All functionsget_moon_phases() + +
Get moon phases for a given year
+
+ get_weekday_name()
Get the weekday name of a date
diff --git a/reference/plot_calendar.html b/reference/plot_calendar.html index c48ce2e..138ff25 100644 --- a/reference/plot_calendar.html +++ b/reference/plot_calendar.html @@ -63,7 +63,8 @@

Usage events = NULL, weekend = FALSE, palette = "#990000", - lang = NULL + lang = NULL, + moon = TRUE ) @@ -122,6 +123,10 @@

Arguments

Value

diff --git a/search.json b/search.json index 1446e13..3504683 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":[]},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement nicolas.casajus@fondationbiodiversite.fr. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired Mozilla’s code conduct enforcement ladder. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to calendar","title":"Contributing to calendar","text":"First , thanks taking time contribute calendar! types contributions encouraged valued. See Table contents different ways help details project handles . Please make sure read relevant section making contribution. make lot easier us maintainers smooth experience involved.","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"table-of-contents","dir":"","previous_headings":"","what":"Table of contents","title":"Contributing to calendar","text":"Code conduct Style guide Commit messages Asking questions Reporting bugs Requesting features Contributing code","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of conduct","title":"Contributing to calendar","text":"project released Contributor Code Conduct. participating, expected uphold code. Please report unacceptable behavior nicolas.casajus@fondationbiodiversite.fr.","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"style-guide","dir":"","previous_headings":"","what":"Style guide","title":"Contributing to calendar","text":"use Tidyverse style guide writing R code. Functions documented roxygen2 syntax. calendar uses lower_snake_case.","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"commit-messages","dir":"","previous_headings":"","what":"Commit messages","title":"Contributing to calendar","text":"want contribute commiting changes, please try use Conventional commits specification.","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"asking-questions","dir":"","previous_headings":"","what":"Asking questions","title":"Contributing to calendar","text":"ask question, best search existing Issues might help . case found suitable issue still need clarification, can write question issue. still feel need ask question need clarification, recommend following: Open new Issue. Use template other_issue.md. Provide much context can ’re running . Provide project platform versions (paste output sessionInfo()). take care issue soon possible.","code":""},{"path":[]},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"before-submitting-a-bug-report","dir":"","previous_headings":"Reporting bugs","what":"Before submitting a bug report","title":"Contributing to calendar","text":"good bug report shouldn’t leave others needing chase information. Therefore, ask investigate carefully, collect information describe issue detail report. Please complete following steps advance help us fix potential bug fast possible. Make sure using latest version calendar. Determine bug really bug error side. see users experienced (potentially already solved) issue , check already bug report existing bug error bug tracker.","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"how-do-i-submit-a-bug-report","dir":"","previous_headings":"Reporting bugs","what":"How do I submit a bug report?","title":"Contributing to calendar","text":"use GitHub Issues track bugs errors. run issue project: Open new Issue. Use template bug_report.md. Explain behavior expect actual behavior. Please provide much context possible describe reproduction steps someone else can follow recreate issue . usually includes code reproducible example. take care issue soon possible.","code":""},{"path":[]},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"before-requesting-a-feature","dir":"","previous_headings":"Requesting features","what":"Before requesting a feature","title":"Contributing to calendar","text":"Make sure using latest version calendar. Read documentation carefully find functionality already covered. Perform search see enhancement already suggested. , add comment existing issue instead opening new one.","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"how-do-i-submit-a-feature-request","dir":"","previous_headings":"Requesting features","what":"How do I submit a feature request?","title":"Contributing to calendar","text":"Feature requests tracked GitHub Issues. Open new Issue. Use template feature_request.md. Provide clear descriptive title issue identify suggestion. Provide step--step description suggested enhancement many details possible. Explain enhancement useful calendar users. take care issue soon possible.","code":""},{"path":[]},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"general-workflow","dir":"","previous_headings":"Contributing code","what":"General workflow","title":"Contributing to calendar","text":"use GitHub flow collaborate project: Fork repository using GitHub interface. Clone fork using git clone fork-url (replace fork-url URL fork). Alternatively, open RStudio IDE create New Project Version Control. Create new branch w/ git checkout -b branch-name (replace branch-name name new branch). Make contribution (see examples). Stage (git add) commit (git commit) changes often necessary Push changes GitHub w/ git push origin branch-name. Submit Pull Request original repo. review PR soon possible.","code":""},{"path":[]},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"editing-the-readme","dir":"","previous_headings":"Contributing code > Improve documentation","what":"Editing the README","title":"Contributing to calendar","text":"want contribute improving README, please edit README.Rmd (README.md). forget update README.md running:","code":"rmarkdown::render(\"README.Rmd\")"},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"editing-vignettes","dir":"","previous_headings":"Contributing code > Improve documentation","what":"Editing vignettes","title":"Contributing to calendar","text":"want contribute editing existing vignette, just edit corresponding Rmd file stored vignettes/ folder. want contribute adding new vignette, create new Rmd file vignettes/ folder add following header: use new external dependency, forget add DESCRIPTION file section Suggests (package already listed section Imports). Check integrity package :","code":"--- title: \"Vignette Title\" output: rmarkdown::html_vignette vignette: > %\\VignetteIndexEntry{Vignette Title} %\\VignetteEngine{knitr::rmarkdown} %\\VignetteEncoding{UTF-8} --- devtools::check()"},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"editing-function-documentation","dir":"","previous_headings":"Contributing code > Improve documentation","what":"Editing function documentation","title":"Contributing to calendar","text":"want contribute improving documentation function, open corresponding file R/ folder edit lines starting #' (roxygen2 syntax). Update documentation (Rd files man/ folder) running: use new external dependency example section, forget add DESCRIPTION file section Imports (package already listed). Check integrity package :","code":"devtools::document() devtools::check()"},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"fix-bug","dir":"","previous_headings":"Contributing code","what":"Fix bug","title":"Contributing to calendar","text":"want contribute improving code function, open edit corresponding file R/ folder. Check integrity package : forget adapt unit tests function editing corresponding file stored tests/testthat/ folder. use package testthat implement unit tests. Check tests running:","code":"devtools::check() devtools::test()"},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"new-feature","dir":"","previous_headings":"Contributing code","what":"New feature","title":"Contributing to calendar","text":"want contribute submitting new feature, please follow workflow: Create new R file folder R/. Implement code function. Document function w/ roxygen2 syntax. necessary, add additional dependencies DESCRIPTION file. Update package documentation w/ devtools::document(). Create new R file folder tests/testthat/. Implement unit tests new function. Check integrity package w/ devtools::check(). Thanks contribution!","code":""},{"path":"https://frbcesab.github.io/calendar/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"GNU General Public License","title":"GNU General Public License","text":"Version 2, June 1991Copyright © 1989, 1991 Free Software Foundation, Inc.,51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone permitted copy distribute verbatim copies license document, changing allowed.","code":""},{"path":"https://frbcesab.github.io/calendar/LICENSE.html","id":"preamble","dir":"","previous_headings":"","what":"Preamble","title":"GNU General Public License","text":"licenses software designed take away freedom share change . contrast, GNU General Public License intended guarantee freedom share change free software–make sure software free users. General Public License applies Free Software Foundation’s software program whose authors commit using . (Free Software Foundation software covered GNU Lesser General Public License instead.) can apply programs, . speak free software, referring freedom, price. General Public Licenses designed make sure freedom distribute copies free software (charge service wish), receive source code can get want , can change software use pieces new free programs; know can things. protect rights, need make restrictions forbid anyone deny rights ask surrender rights. restrictions translate certain responsibilities distribute copies software, modify . example, distribute copies program, whether gratis fee, must give recipients rights . must make sure , , receive can get source code. must show terms know rights. protect rights two steps: (1) copyright software, (2) offer license gives legal permission copy, distribute /modify software. Also, author’s protection , want make certain everyone understands warranty free software. software modified someone else passed , want recipients know original, problems introduced others reflect original authors’ reputations. Finally, free program threatened constantly software patents. wish avoid danger redistributors free program individually obtain patent licenses, effect making program proprietary. prevent , made clear patent must licensed everyone’s free use licensed . precise terms conditions copying, distribution modification follow.","code":""},{"path":"https://frbcesab.github.io/calendar/LICENSE.html","id":"terms-and-conditions-for-copying-distribution-and-modification","dir":"","previous_headings":"","what":"TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION","title":"GNU General Public License","text":"0. License applies program work contains notice placed copyright holder saying may distributed terms General Public License. “Program”, , refers program work, “work based Program” means either Program derivative work copyright law: say, work containing Program portion , either verbatim modifications /translated another language. (Hereinafter, translation included without limitation term “modification”.) licensee addressed “”. Activities copying, distribution modification covered License; outside scope. act running Program restricted, output Program covered contents constitute work based Program (independent made running Program). Whether true depends Program . 1. may copy distribute verbatim copies Program’s source code receive , medium, provided conspicuously appropriately publish copy appropriate copyright notice disclaimer warranty; keep intact notices refer License absence warranty; give recipients Program copy License along Program. may charge fee physical act transferring copy, may option offer warranty protection exchange fee. 2. may modify copy copies Program portion , thus forming work based Program, copy distribute modifications work terms Section 1 , provided also meet conditions: ) must cause modified files carry prominent notices stating changed files date change. b) must cause work distribute publish, whole part contains derived Program part thereof, licensed whole charge third parties terms License. c) modified program normally reads commands interactively run, must cause , started running interactive use ordinary way, print display announcement including appropriate copyright notice notice warranty (else, saying provide warranty) users may redistribute program conditions, telling user view copy License. (Exception: Program interactive normally print announcement, work based Program required print announcement.) requirements apply modified work whole. identifiable sections work derived Program, can reasonably considered independent separate works , License, terms, apply sections distribute separate works. distribute sections part whole work based Program, distribution whole must terms License, whose permissions licensees extend entire whole, thus every part regardless wrote . Thus, intent section claim rights contest rights work written entirely ; rather, intent exercise right control distribution derivative collective works based Program. addition, mere aggregation another work based Program Program (work based Program) volume storage distribution medium bring work scope License. 3. may copy distribute Program (work based , Section 2) object code executable form terms Sections 1 2 provided also one following: ) Accompany complete corresponding machine-readable source code, must distributed terms Sections 1 2 medium customarily used software interchange; , b) Accompany written offer, valid least three years, give third party, charge cost physically performing source distribution, complete machine-readable copy corresponding source code, distributed terms Sections 1 2 medium customarily used software interchange; , c) Accompany information received offer distribute corresponding source code. (alternative allowed noncommercial distribution received program object code executable form offer, accord Subsection b .) source code work means preferred form work making modifications . executable work, complete source code means source code modules contains, plus associated interface definition files, plus scripts used control compilation installation executable. However, special exception, source code distributed need include anything normally distributed (either source binary form) major components (compiler, kernel, ) operating system executable runs, unless component accompanies executable. distribution executable object code made offering access copy designated place, offering equivalent access copy source code place counts distribution source code, even though third parties compelled copy source along object code. 4. may copy, modify, sublicense, distribute Program except expressly provided License. attempt otherwise copy, modify, sublicense distribute Program void, automatically terminate rights License. However, parties received copies, rights, License licenses terminated long parties remain full compliance. 5. required accept License, since signed . However, nothing else grants permission modify distribute Program derivative works. actions prohibited law accept License. Therefore, modifying distributing Program (work based Program), indicate acceptance License , terms conditions copying, distributing modifying Program works based . 6. time redistribute Program (work based Program), recipient automatically receives license original licensor copy, distribute modify Program subject terms conditions. may impose restrictions recipients’ exercise rights granted herein. responsible enforcing compliance third parties License. 7. , consequence court judgment allegation patent infringement reason (limited patent issues), conditions imposed (whether court order, agreement otherwise) contradict conditions License, excuse conditions License. distribute satisfy simultaneously obligations License pertinent obligations, consequence may distribute Program . example, patent license permit royalty-free redistribution Program receive copies directly indirectly , way satisfy License refrain entirely distribution Program. portion section held invalid unenforceable particular circumstance, balance section intended apply section whole intended apply circumstances. purpose section induce infringe patents property right claims contest validity claims; section sole purpose protecting integrity free software distribution system, implemented public license practices. Many people made generous contributions wide range software distributed system reliance consistent application system; author/donor decide willing distribute software system licensee impose choice. section intended make thoroughly clear believed consequence rest License. 8. distribution /use Program restricted certain countries either patents copyrighted interfaces, original copyright holder places Program License may add explicit geographical distribution limitation excluding countries, distribution permitted among countries thus excluded. case, License incorporates limitation written body License. 9. Free Software Foundation may publish revised /new versions General Public License time time. new versions similar spirit present version, may differ detail address new problems concerns. version given distinguishing version number. Program specifies version number License applies “later version”, option following terms conditions either version later version published Free Software Foundation. Program specify version number License, may choose version ever published Free Software Foundation. 10. wish incorporate parts Program free programs whose distribution conditions different, write author ask permission. software copyrighted Free Software Foundation, write Free Software Foundation; sometimes make exceptions . decision guided two goals preserving free status derivatives free software promoting sharing reuse software generally.","code":""},{"path":"https://frbcesab.github.io/calendar/LICENSE.html","id":"no-warranty","dir":"","previous_headings":"","what":"NO WARRANTY","title":"GNU General Public License","text":"11. PROGRAM LICENSED FREE CHARGE, WARRANTY PROGRAM, EXTENT PERMITTED APPLICABLE LAW. EXCEPT OTHERWISE STATED WRITING COPYRIGHT HOLDERS /PARTIES PROVIDE PROGRAM “” WITHOUT WARRANTY KIND, EITHER EXPRESSED IMPLIED, INCLUDING, LIMITED , IMPLIED WARRANTIES MERCHANTABILITY FITNESS PARTICULAR PURPOSE. ENTIRE RISK QUALITY PERFORMANCE PROGRAM . PROGRAM PROVE DEFECTIVE, ASSUME COST NECESSARY SERVICING, REPAIR CORRECTION. 12. EVENT UNLESS REQUIRED APPLICABLE LAW AGREED WRITING COPYRIGHT HOLDER, PARTY MAY MODIFY /REDISTRIBUTE PROGRAM PERMITTED , LIABLE DAMAGES, INCLUDING GENERAL, SPECIAL, INCIDENTAL CONSEQUENTIAL DAMAGES ARISING USE INABILITY USE PROGRAM (INCLUDING LIMITED LOSS DATA DATA RENDERED INACCURATE LOSSES SUSTAINED THIRD PARTIES FAILURE PROGRAM OPERATE PROGRAMS), EVEN HOLDER PARTY ADVISED POSSIBILITY DAMAGES. END TERMS CONDITIONS","code":""},{"path":"https://frbcesab.github.io/calendar/LICENSE.html","id":"how-to-apply-these-terms-to-your-new-programs","dir":"","previous_headings":"","what":"How to Apply These Terms to Your New Programs","title":"GNU General Public License","text":"develop new program, want greatest possible use public, best way achieve make free software everyone can redistribute change terms. , attach following notices program. safest attach start source file effectively convey exclusion warranty; file least “copyright” line pointer full notice found. Also add information contact electronic paper mail. program interactive, make output short notice like starts interactive mode: hypothetical commands show w show c show appropriate parts General Public License. course, commands use may called something show w show c; even mouse-clicks menu items–whatever suits program. also get employer (work programmer) school, , sign “copyright disclaimer” program, necessary. sample; alter names: General Public License permit incorporating program proprietary programs. program subroutine library, may consider useful permit linking proprietary applications library. want , use GNU Lesser General Public License instead License.","code":" Copyright (C) This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice"},{"path":"https://frbcesab.github.io/calendar/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Nicolas Casajus. Author, maintainer, copyright holder.","code":""},{"path":"https://frbcesab.github.io/calendar/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Casajus Nicolas (2024). calendar: R package create monthly calendar. R package version 0.0.0.9000, https://github.com/frbcesab/calendar.","code":"@Manual{, title = {calendar: {An} {R} package to create a monthly calendar}, author = {{Casajus Nicolas}}, year = {2024}, note = {R package version 0.0.0.9000}, url = {https://github.com/frbcesab/calendar}, }"},{"path":"https://frbcesab.github.io/calendar/index.html","id":"calendar-","dir":"","previous_headings":"","what":"Create a Monthly Calendar with Events","title":"Create a Monthly Calendar with Events","text":"• Overview • Installation • Get started • Citation • Contributing • Acknowledgments","code":""},{"path":"https://frbcesab.github.io/calendar/index.html","id":"overview","dir":"","previous_headings":"","what":"Overview","title":"Create a Monthly Calendar with Events","text":"R package calendar dedicated create monthly calendar. plots exports calendar pdf file (ready print A4 paper format). Holidays (France supported yet) identified user can easily add events (four day). User can also choose week five days (working week) full week (weekend included). Empty monthly calendar (weekends) Empty monthly calendar (without weekend) Monthly calendar single-day events Monthly calendar multi-day events Monthly calendar multi-week events --one","code":""},{"path":"https://frbcesab.github.io/calendar/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Create a Monthly Calendar with Events","text":"can install development version GitHub : can attach package calendar:","code":"## Install < remotes > package (if not already installed) ---- if (!requireNamespace(\"remotes\", quietly = TRUE)) { install.packages(\"remotes\") } ## Install < calendar > from GitHub ---- remotes::install_github(\"frbcesab/calendar\") library(\"calendar\")"},{"path":"https://frbcesab.github.io/calendar/index.html","id":"get-started","dir":"","previous_headings":"","what":"Get started","title":"Create a Monthly Calendar with Events","text":"overview main features calendar, please read Get started vignette.","code":""},{"path":"https://frbcesab.github.io/calendar/index.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Create a Monthly Calendar with Events","text":"Please cite calendar : Casajus Nicolas (2024) calendar: R package create monthly calendar. R package version 0.0.0.9000. https://github.com/frbcesab/calendar/","code":""},{"path":"https://frbcesab.github.io/calendar/index.html","id":"contributing","dir":"","previous_headings":"","what":"Contributing","title":"Create a Monthly Calendar with Events","text":"types contributions encouraged valued. information, check Contributor Guidelines. Please note calendar project released Contributor Code Conduct. contributing project, agree abide terms.","code":""},{"path":"https://frbcesab.github.io/calendar/index.html","id":"acknowledgments","dir":"","previous_headings":"","what":"Acknowledgments","title":"Create a Monthly Calendar with Events","text":"package developed part FRB-CESAB work.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/calendar-package.html","id":null,"dir":"Reference","previous_headings":"","what":"calendar: Create a Monthly Calendar with Events — calendar-package","title":"calendar: Create a Monthly Calendar with Events — calendar-package","text":"Plots exports monthly calendar 'pdf'. Holidays (France ) identified. User can easily add events (four day) choose week five days (working week) full week (weekend included).","code":""},{"path":[]},{"path":"https://frbcesab.github.io/calendar/reference/calendar-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"calendar: Create a Monthly Calendar with Events — calendar-package","text":"Maintainer: Nicolas Casajus nicolas.casajus@fondationbiodiversite.fr (ORCID) [copyright holder]","code":""},{"path":"https://frbcesab.github.io/calendar/reference/filter_events.html","id":null,"dir":"Reference","previous_headings":"","what":"Filter calendar events to match the extent on the calendar — filter_events","title":"Filter calendar events to match the extent on the calendar — filter_events","text":"Filter calendar events match extent calendar","code":""},{"path":"https://frbcesab.github.io/calendar/reference/filter_events.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Filter calendar events to match the extent on the calendar — filter_events","text":"","code":"filter_events( data, year = format(Sys.Date(), \"%Y\"), month = format(Sys.Date(), \"%m\"), format = \"%Y-%m-%d\", weekend = FALSE )"},{"path":"https://frbcesab.github.io/calendar/reference/filter_events.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Filter calendar events to match the extent on the calendar — filter_events","text":"data data.frame least following columns: , start event, , end event, event, name event, category, category event (used different colors). year either integer character length 1. Must 4 characters (e.g. '2024' '24'). Default current year. month either integer character length 1. Must 1 2 characters (e.g. '01' '1'). Default current month. format character length 1. Used specify format date. Default \"%Y-%m-%d\" (.e. 2024-12-25). weekend logical. TRUE keeps Saturdays Sundays. Default FALSE.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/filter_events.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Filter calendar events to match the extent on the calendar — filter_events","text":"data.frame, input events matching extent calendar.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/filter_events.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Filter calendar events to match the extent on the calendar — filter_events","text":"","code":"## No example ---"},{"path":"https://frbcesab.github.io/calendar/reference/get_calendar.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the calendar for a given month and year — get_calendar","title":"Get the calendar for a given month and year — get_calendar","text":"Get calendar given month year","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_calendar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the calendar for a given month and year — get_calendar","text":"","code":"get_calendar( year = format(Sys.Date(), \"%Y\"), month = format(Sys.Date(), \"%m\"), weekend = FALSE, lang = NULL )"},{"path":"https://frbcesab.github.io/calendar/reference/get_calendar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the calendar for a given month and year — get_calendar","text":"year either integer character length 1. Must 4 characters (e.g. '2024' '24'). Default current year. month either integer character length 1. Must 1 2 characters (e.g. '01' '1'). Default current month. weekend logical. TRUE keeps Saturdays Sundays. Default FALSE. lang character length 1. Used change default locale (.e. language). Default NULL (.e. use current locale). See examples . Depending OS locale, output can weird.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_calendar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the calendar for a given month and year — get_calendar","text":"data.frame following columns: date: date day (YYYY-MM-DD), year: year day (integer), month: month day (integer), day: day (integer), week: number week (integer), weekday: name day week (character), month_name: name month (character), x: position x-axis (used plot_calendar()), y: position y-axis (used plot_calendar()).","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_calendar.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get the calendar for a given month and year — get_calendar","text":"","code":"## Calendar for the current month ---- head(get_calendar()) #> date year month day week en_weekday en_month_name user_weekday #> 1 2024-03-01 2024 3 1 9 Friday March Friday #> 2 2024-03-04 2024 3 4 10 Monday March Monday #> 3 2024-03-05 2024 3 5 10 Tuesday March Tuesday #> 4 2024-03-06 2024 3 6 10 Wednesday March Wednesday #> 5 2024-03-07 2024 3 7 10 Thursday March Thursday #> 6 2024-03-08 2024 3 8 10 Friday March Friday #> user_month_name x y #> 1 March 5 6 #> 2 March 1 5 #> 3 March 2 5 #> 4 March 3 5 #> 5 March 4 5 #> 6 March 5 5 ## Calendar for December (current year) ---- head(get_calendar(month = 12)) #> date year month day week en_weekday en_month_name user_weekday #> 1 2024-12-02 2024 12 2 49 Monday December Monday #> 2 2024-12-03 2024 12 3 49 Tuesday December Tuesday #> 3 2024-12-04 2024 12 4 49 Wednesday December Wednesday #> 4 2024-12-05 2024 12 5 49 Thursday December Thursday #> 5 2024-12-06 2024 12 6 49 Friday December Friday #> 6 2024-12-09 2024 12 9 50 Monday December Monday #> user_month_name x y #> 1 December 1 6 #> 2 December 2 6 #> 3 December 3 6 #> 4 December 4 6 #> 5 December 5 6 #> 6 December 1 5 ## Calendar for April (current year) ---- head(get_calendar(month = 4)) #> date year month day week en_weekday en_month_name user_weekday #> 1 2024-04-01 2024 4 1 14 Monday April Monday #> 2 2024-04-02 2024 4 2 14 Tuesday April Tuesday #> 3 2024-04-03 2024 4 3 14 Wednesday April Wednesday #> 4 2024-04-04 2024 4 4 14 Thursday April Thursday #> 5 2024-04-05 2024 4 5 14 Friday April Friday #> 6 2024-04-08 2024 4 8 15 Monday April Monday #> user_month_name x y #> 1 April 1 6 #> 2 April 2 6 #> 3 April 3 6 #> 4 April 4 6 #> 5 April 5 6 #> 6 April 1 5 ## Calendar for January 1970 ---- head(get_calendar(year = 1970, month = 1)) #> date year month day week en_weekday en_month_name user_weekday #> 1 1970-01-01 1970 1 1 0 Thursday January Thursday #> 2 1970-01-02 1970 1 2 0 Friday January Friday #> 3 1970-01-05 1970 1 5 1 Monday January Monday #> 4 1970-01-06 1970 1 6 1 Tuesday January Tuesday #> 5 1970-01-07 1970 1 7 1 Wednesday January Wednesday #> 6 1970-01-08 1970 1 8 1 Thursday January Thursday #> user_month_name x y #> 1 January 4 6 #> 2 January 5 6 #> 3 January 1 5 #> 4 January 2 5 #> 5 January 3 5 #> 6 January 4 5 if (FALSE) { ## Change the locale (Spanish) ---- head(get_calendar(year = 1970, month = 1, lang = \"Spanish\")) }"},{"path":"https://frbcesab.github.io/calendar/reference/get_month_name.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the name of a month — get_month_name","title":"Get the name of a month — get_month_name","text":"Get name month","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_month_name.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the name of a month — get_month_name","text":"","code":"get_month_name(month, lang = NULL)"},{"path":"https://frbcesab.github.io/calendar/reference/get_month_name.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the name of a month — get_month_name","text":"month integer length 1. month convert letters. lang character length 1. Used change default locale (.e. language). Default NULL (.e. use current locale). See examples . Depending OS locale, output can weird.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_month_name.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the name of a month — get_month_name","text":"character length 1.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_month_name.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get the name of a month — get_month_name","text":"","code":"## Default ---- get_month_name(month = 4) #> [1] \"April\" if (FALSE) { ## Get Spanish name ---- get_month_name(month = 4, lang = \"Spanish\") ## Get Finnish name ---- get_month_name(month = 4, lang = \"Finnish\") }"},{"path":"https://frbcesab.github.io/calendar/reference/get_weekday_name.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the weekday name of a date — get_weekday_name","title":"Get the weekday name of a date — get_weekday_name","text":"Get weekday name date","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_weekday_name.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the weekday name of a date — get_weekday_name","text":"","code":"get_weekday_name(date, format = \"%Y-%m-%d\", lang = NULL)"},{"path":"https://frbcesab.github.io/calendar/reference/get_weekday_name.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the weekday name of a date — get_weekday_name","text":"date either character Date length 1. date extract weekday name. See examples . format character length 1. Used specify format date. Default \"%Y-%m-%d\" (.e. 2024-12-25). See examples . lang character length 1. Used change default locale (.e. language). Default NULL (.e. use current locale). See examples . Depending OS locale, output can weird.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_weekday_name.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the weekday name of a date — get_weekday_name","text":"character length 1.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_weekday_name.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get the weekday name of a date — get_weekday_name","text":"","code":"## Default ---- get_weekday_name(\"2024-04-01\") #> [1] \"Monday\" ## Change date format ---- get_weekday_name(\"01/04/2024\", format = \"%d/%m/%Y\") #> [1] \"Monday\" if (FALSE) { ## Get Spanish name ---- get_weekday_name(\"2024-04-01\", lang = \"Spanish\") ## Get Finnish name ---- get_weekday_name(\"2024-04-01\", lang = \"Finnish\") }"},{"path":"https://frbcesab.github.io/calendar/reference/number_of_days.html","id":null,"dir":"Reference","previous_headings":"","what":"Return the number of days in a month for a given year — number_of_days","title":"Return the number of days in a month for a given year — number_of_days","text":"Return number days month given year","code":""},{"path":"https://frbcesab.github.io/calendar/reference/number_of_days.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Return the number of days in a month for a given year — number_of_days","text":"","code":"number_of_days(date, format = \"%Y-%m-%d\")"},{"path":"https://frbcesab.github.io/calendar/reference/number_of_days.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Return the number of days in a month for a given year — number_of_days","text":"date either character Date length 1. See examples . format character length 1. Used specify format date. Default \"%Y-%m-%d\" (.e. 2024-12-25). See examples .","code":""},{"path":"https://frbcesab.github.io/calendar/reference/number_of_days.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Return the number of days in a month for a given year — number_of_days","text":"integer corresponding number days month specified year.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/number_of_days.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Return the number of days in a month for a given year — number_of_days","text":"","code":"## Default ---- number_of_days(\"2024-02-01\") #> [1] 29 ## Day doesn't matter ---- number_of_days(\"2024-02-23\") #> [1] 29 ## Year matters ---- number_of_days(\"2023-02-23\") #> [1] 28 ## Change the format ---- number_of_days(\"2024/02/23\", format = \"%Y/%m/%d\") #> [1] 29 ## French format ---- number_of_days(\"23/02/2024\", format = \"%d/%m/%Y\") #> [1] 29"},{"path":"https://frbcesab.github.io/calendar/reference/plot_calendar.html","id":null,"dir":"Reference","previous_headings":"","what":"Export a monthly calendar as pdf — plot_calendar","title":"Export a monthly calendar as pdf — plot_calendar","text":"Export monthly calendar pdf","code":""},{"path":"https://frbcesab.github.io/calendar/reference/plot_calendar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Export a monthly calendar as pdf — plot_calendar","text":"","code":"plot_calendar( year = format(Sys.Date(), \"%Y\"), month = format(Sys.Date(), \"%m\"), path = getwd(), filename = NULL, title = NULL, events = NULL, weekend = FALSE, palette = \"#990000\", lang = NULL )"},{"path":"https://frbcesab.github.io/calendar/reference/plot_calendar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Export a monthly calendar as pdf — plot_calendar","text":"year either integer character length 1. Must 4 characters (e.g. '2024' '24'). Default current year. month either integer character length 1. Must 1 2 characters (e.g. '01' '1'). Default current month. path character length 1. directory save pdf file. Must exist. Default current directory. filename character length 1. name pdf file. Default calendar-YYYY-MM.pdf (e.g. calendar-2024-04.pdf). title character length 1. title calendar. Default Month YYYY (e.g. April 2024). events optional data.frame following columns: event, name event, , starting date event, , ending date event, category, category event. weekend logical. TRUE keeps Saturdays Sundays. Default FALSE. palette character vector colors events. one color provided (default), events color. several colors provided, number colors palette must equal total number event categories (duplicated colors accepted). Moreover, palette argument must named vector, names match event categories. example, events object contains two categories (cat_a cat_b), palette argument must equal palette = c(\"cat_a\" = \"black\", \"cat_b\" = \"red\"). lang character length 1. Used change default locale (.e. language). Default NULL (.e. use current locale). See examples . Depending OS locale, output can weird.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/plot_calendar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Export a monthly calendar as pdf — plot_calendar","text":"return value. calendar exported pdf file path.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/plot_calendar.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Export a monthly calendar as pdf — plot_calendar","text":"","code":"if (FALSE) { ## Add an example ---- }"},{"path":[]}] +[{"path":[]},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement nicolas.casajus@fondationbiodiversite.fr. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://frbcesab.github.io/calendar/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired Mozilla’s code conduct enforcement ladder. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to calendar","title":"Contributing to calendar","text":"First , thanks taking time contribute calendar! types contributions encouraged valued. See Table contents different ways help details project handles . Please make sure read relevant section making contribution. make lot easier us maintainers smooth experience involved.","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"table-of-contents","dir":"","previous_headings":"","what":"Table of contents","title":"Contributing to calendar","text":"Code conduct Style guide Commit messages Asking questions Reporting bugs Requesting features Contributing code","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of conduct","title":"Contributing to calendar","text":"project released Contributor Code Conduct. participating, expected uphold code. Please report unacceptable behavior nicolas.casajus@fondationbiodiversite.fr.","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"style-guide","dir":"","previous_headings":"","what":"Style guide","title":"Contributing to calendar","text":"use Tidyverse style guide writing R code. Functions documented roxygen2 syntax. calendar uses lower_snake_case.","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"commit-messages","dir":"","previous_headings":"","what":"Commit messages","title":"Contributing to calendar","text":"want contribute commiting changes, please try use Conventional commits specification.","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"asking-questions","dir":"","previous_headings":"","what":"Asking questions","title":"Contributing to calendar","text":"ask question, best search existing Issues might help . case found suitable issue still need clarification, can write question issue. still feel need ask question need clarification, recommend following: Open new Issue. Use template other_issue.md. Provide much context can ’re running . Provide project platform versions (paste output sessionInfo()). take care issue soon possible.","code":""},{"path":[]},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"before-submitting-a-bug-report","dir":"","previous_headings":"Reporting bugs","what":"Before submitting a bug report","title":"Contributing to calendar","text":"good bug report shouldn’t leave others needing chase information. Therefore, ask investigate carefully, collect information describe issue detail report. Please complete following steps advance help us fix potential bug fast possible. Make sure using latest version calendar. Determine bug really bug error side. see users experienced (potentially already solved) issue , check already bug report existing bug error bug tracker.","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"how-do-i-submit-a-bug-report","dir":"","previous_headings":"Reporting bugs","what":"How do I submit a bug report?","title":"Contributing to calendar","text":"use GitHub Issues track bugs errors. run issue project: Open new Issue. Use template bug_report.md. Explain behavior expect actual behavior. Please provide much context possible describe reproduction steps someone else can follow recreate issue . usually includes code reproducible example. take care issue soon possible.","code":""},{"path":[]},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"before-requesting-a-feature","dir":"","previous_headings":"Requesting features","what":"Before requesting a feature","title":"Contributing to calendar","text":"Make sure using latest version calendar. Read documentation carefully find functionality already covered. Perform search see enhancement already suggested. , add comment existing issue instead opening new one.","code":""},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"how-do-i-submit-a-feature-request","dir":"","previous_headings":"Requesting features","what":"How do I submit a feature request?","title":"Contributing to calendar","text":"Feature requests tracked GitHub Issues. Open new Issue. Use template feature_request.md. Provide clear descriptive title issue identify suggestion. Provide step--step description suggested enhancement many details possible. Explain enhancement useful calendar users. take care issue soon possible.","code":""},{"path":[]},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"general-workflow","dir":"","previous_headings":"Contributing code","what":"General workflow","title":"Contributing to calendar","text":"use GitHub flow collaborate project: Fork repository using GitHub interface. Clone fork using git clone fork-url (replace fork-url URL fork). Alternatively, open RStudio IDE create New Project Version Control. Create new branch w/ git checkout -b branch-name (replace branch-name name new branch). Make contribution (see examples). Stage (git add) commit (git commit) changes often necessary Push changes GitHub w/ git push origin branch-name. Submit Pull Request original repo. review PR soon possible.","code":""},{"path":[]},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"editing-the-readme","dir":"","previous_headings":"Contributing code > Improve documentation","what":"Editing the README","title":"Contributing to calendar","text":"want contribute improving README, please edit README.Rmd (README.md). forget update README.md running:","code":"rmarkdown::render(\"README.Rmd\")"},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"editing-vignettes","dir":"","previous_headings":"Contributing code > Improve documentation","what":"Editing vignettes","title":"Contributing to calendar","text":"want contribute editing existing vignette, just edit corresponding Rmd file stored vignettes/ folder. want contribute adding new vignette, create new Rmd file vignettes/ folder add following header: use new external dependency, forget add DESCRIPTION file section Suggests (package already listed section Imports). Check integrity package :","code":"--- title: \"Vignette Title\" output: rmarkdown::html_vignette vignette: > %\\VignetteIndexEntry{Vignette Title} %\\VignetteEngine{knitr::rmarkdown} %\\VignetteEncoding{UTF-8} --- devtools::check()"},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"editing-function-documentation","dir":"","previous_headings":"Contributing code > Improve documentation","what":"Editing function documentation","title":"Contributing to calendar","text":"want contribute improving documentation function, open corresponding file R/ folder edit lines starting #' (roxygen2 syntax). Update documentation (Rd files man/ folder) running: use new external dependency example section, forget add DESCRIPTION file section Imports (package already listed). Check integrity package :","code":"devtools::document() devtools::check()"},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"fix-bug","dir":"","previous_headings":"Contributing code","what":"Fix bug","title":"Contributing to calendar","text":"want contribute improving code function, open edit corresponding file R/ folder. Check integrity package : forget adapt unit tests function editing corresponding file stored tests/testthat/ folder. use package testthat implement unit tests. Check tests running:","code":"devtools::check() devtools::test()"},{"path":"https://frbcesab.github.io/calendar/CONTRIBUTING.html","id":"new-feature","dir":"","previous_headings":"Contributing code","what":"New feature","title":"Contributing to calendar","text":"want contribute submitting new feature, please follow workflow: Create new R file folder R/. Implement code function. Document function w/ roxygen2 syntax. necessary, add additional dependencies DESCRIPTION file. Update package documentation w/ devtools::document(). Create new R file folder tests/testthat/. Implement unit tests new function. Check integrity package w/ devtools::check(). Thanks contribution!","code":""},{"path":"https://frbcesab.github.io/calendar/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"GNU General Public License","title":"GNU General Public License","text":"Version 2, June 1991Copyright © 1989, 1991 Free Software Foundation, Inc.,51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone permitted copy distribute verbatim copies license document, changing allowed.","code":""},{"path":"https://frbcesab.github.io/calendar/LICENSE.html","id":"preamble","dir":"","previous_headings":"","what":"Preamble","title":"GNU General Public License","text":"licenses software designed take away freedom share change . contrast, GNU General Public License intended guarantee freedom share change free software–make sure software free users. General Public License applies Free Software Foundation’s software program whose authors commit using . (Free Software Foundation software covered GNU Lesser General Public License instead.) can apply programs, . speak free software, referring freedom, price. General Public Licenses designed make sure freedom distribute copies free software (charge service wish), receive source code can get want , can change software use pieces new free programs; know can things. protect rights, need make restrictions forbid anyone deny rights ask surrender rights. restrictions translate certain responsibilities distribute copies software, modify . example, distribute copies program, whether gratis fee, must give recipients rights . must make sure , , receive can get source code. must show terms know rights. protect rights two steps: (1) copyright software, (2) offer license gives legal permission copy, distribute /modify software. Also, author’s protection , want make certain everyone understands warranty free software. software modified someone else passed , want recipients know original, problems introduced others reflect original authors’ reputations. Finally, free program threatened constantly software patents. wish avoid danger redistributors free program individually obtain patent licenses, effect making program proprietary. prevent , made clear patent must licensed everyone’s free use licensed . precise terms conditions copying, distribution modification follow.","code":""},{"path":"https://frbcesab.github.io/calendar/LICENSE.html","id":"terms-and-conditions-for-copying-distribution-and-modification","dir":"","previous_headings":"","what":"TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION","title":"GNU General Public License","text":"0. License applies program work contains notice placed copyright holder saying may distributed terms General Public License. “Program”, , refers program work, “work based Program” means either Program derivative work copyright law: say, work containing Program portion , either verbatim modifications /translated another language. (Hereinafter, translation included without limitation term “modification”.) licensee addressed “”. Activities copying, distribution modification covered License; outside scope. act running Program restricted, output Program covered contents constitute work based Program (independent made running Program). Whether true depends Program . 1. may copy distribute verbatim copies Program’s source code receive , medium, provided conspicuously appropriately publish copy appropriate copyright notice disclaimer warranty; keep intact notices refer License absence warranty; give recipients Program copy License along Program. may charge fee physical act transferring copy, may option offer warranty protection exchange fee. 2. may modify copy copies Program portion , thus forming work based Program, copy distribute modifications work terms Section 1 , provided also meet conditions: ) must cause modified files carry prominent notices stating changed files date change. b) must cause work distribute publish, whole part contains derived Program part thereof, licensed whole charge third parties terms License. c) modified program normally reads commands interactively run, must cause , started running interactive use ordinary way, print display announcement including appropriate copyright notice notice warranty (else, saying provide warranty) users may redistribute program conditions, telling user view copy License. (Exception: Program interactive normally print announcement, work based Program required print announcement.) requirements apply modified work whole. identifiable sections work derived Program, can reasonably considered independent separate works , License, terms, apply sections distribute separate works. distribute sections part whole work based Program, distribution whole must terms License, whose permissions licensees extend entire whole, thus every part regardless wrote . Thus, intent section claim rights contest rights work written entirely ; rather, intent exercise right control distribution derivative collective works based Program. addition, mere aggregation another work based Program Program (work based Program) volume storage distribution medium bring work scope License. 3. may copy distribute Program (work based , Section 2) object code executable form terms Sections 1 2 provided also one following: ) Accompany complete corresponding machine-readable source code, must distributed terms Sections 1 2 medium customarily used software interchange; , b) Accompany written offer, valid least three years, give third party, charge cost physically performing source distribution, complete machine-readable copy corresponding source code, distributed terms Sections 1 2 medium customarily used software interchange; , c) Accompany information received offer distribute corresponding source code. (alternative allowed noncommercial distribution received program object code executable form offer, accord Subsection b .) source code work means preferred form work making modifications . executable work, complete source code means source code modules contains, plus associated interface definition files, plus scripts used control compilation installation executable. However, special exception, source code distributed need include anything normally distributed (either source binary form) major components (compiler, kernel, ) operating system executable runs, unless component accompanies executable. distribution executable object code made offering access copy designated place, offering equivalent access copy source code place counts distribution source code, even though third parties compelled copy source along object code. 4. may copy, modify, sublicense, distribute Program except expressly provided License. attempt otherwise copy, modify, sublicense distribute Program void, automatically terminate rights License. However, parties received copies, rights, License licenses terminated long parties remain full compliance. 5. required accept License, since signed . However, nothing else grants permission modify distribute Program derivative works. actions prohibited law accept License. Therefore, modifying distributing Program (work based Program), indicate acceptance License , terms conditions copying, distributing modifying Program works based . 6. time redistribute Program (work based Program), recipient automatically receives license original licensor copy, distribute modify Program subject terms conditions. may impose restrictions recipients’ exercise rights granted herein. responsible enforcing compliance third parties License. 7. , consequence court judgment allegation patent infringement reason (limited patent issues), conditions imposed (whether court order, agreement otherwise) contradict conditions License, excuse conditions License. distribute satisfy simultaneously obligations License pertinent obligations, consequence may distribute Program . example, patent license permit royalty-free redistribution Program receive copies directly indirectly , way satisfy License refrain entirely distribution Program. portion section held invalid unenforceable particular circumstance, balance section intended apply section whole intended apply circumstances. purpose section induce infringe patents property right claims contest validity claims; section sole purpose protecting integrity free software distribution system, implemented public license practices. Many people made generous contributions wide range software distributed system reliance consistent application system; author/donor decide willing distribute software system licensee impose choice. section intended make thoroughly clear believed consequence rest License. 8. distribution /use Program restricted certain countries either patents copyrighted interfaces, original copyright holder places Program License may add explicit geographical distribution limitation excluding countries, distribution permitted among countries thus excluded. case, License incorporates limitation written body License. 9. Free Software Foundation may publish revised /new versions General Public License time time. new versions similar spirit present version, may differ detail address new problems concerns. version given distinguishing version number. Program specifies version number License applies “later version”, option following terms conditions either version later version published Free Software Foundation. Program specify version number License, may choose version ever published Free Software Foundation. 10. wish incorporate parts Program free programs whose distribution conditions different, write author ask permission. software copyrighted Free Software Foundation, write Free Software Foundation; sometimes make exceptions . decision guided two goals preserving free status derivatives free software promoting sharing reuse software generally.","code":""},{"path":"https://frbcesab.github.io/calendar/LICENSE.html","id":"no-warranty","dir":"","previous_headings":"","what":"NO WARRANTY","title":"GNU General Public License","text":"11. PROGRAM LICENSED FREE CHARGE, WARRANTY PROGRAM, EXTENT PERMITTED APPLICABLE LAW. EXCEPT OTHERWISE STATED WRITING COPYRIGHT HOLDERS /PARTIES PROVIDE PROGRAM “” WITHOUT WARRANTY KIND, EITHER EXPRESSED IMPLIED, INCLUDING, LIMITED , IMPLIED WARRANTIES MERCHANTABILITY FITNESS PARTICULAR PURPOSE. ENTIRE RISK QUALITY PERFORMANCE PROGRAM . PROGRAM PROVE DEFECTIVE, ASSUME COST NECESSARY SERVICING, REPAIR CORRECTION. 12. EVENT UNLESS REQUIRED APPLICABLE LAW AGREED WRITING COPYRIGHT HOLDER, PARTY MAY MODIFY /REDISTRIBUTE PROGRAM PERMITTED , LIABLE DAMAGES, INCLUDING GENERAL, SPECIAL, INCIDENTAL CONSEQUENTIAL DAMAGES ARISING USE INABILITY USE PROGRAM (INCLUDING LIMITED LOSS DATA DATA RENDERED INACCURATE LOSSES SUSTAINED THIRD PARTIES FAILURE PROGRAM OPERATE PROGRAMS), EVEN HOLDER PARTY ADVISED POSSIBILITY DAMAGES. END TERMS CONDITIONS","code":""},{"path":"https://frbcesab.github.io/calendar/LICENSE.html","id":"how-to-apply-these-terms-to-your-new-programs","dir":"","previous_headings":"","what":"How to Apply These Terms to Your New Programs","title":"GNU General Public License","text":"develop new program, want greatest possible use public, best way achieve make free software everyone can redistribute change terms. , attach following notices program. safest attach start source file effectively convey exclusion warranty; file least “copyright” line pointer full notice found. Also add information contact electronic paper mail. program interactive, make output short notice like starts interactive mode: hypothetical commands show w show c show appropriate parts General Public License. course, commands use may called something show w show c; even mouse-clicks menu items–whatever suits program. also get employer (work programmer) school, , sign “copyright disclaimer” program, necessary. sample; alter names: General Public License permit incorporating program proprietary programs. program subroutine library, may consider useful permit linking proprietary applications library. want , use GNU Lesser General Public License instead License.","code":" Copyright (C) This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice"},{"path":"https://frbcesab.github.io/calendar/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Nicolas Casajus. Author, maintainer, copyright holder.","code":""},{"path":"https://frbcesab.github.io/calendar/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Casajus Nicolas (2024). calendar: R package create monthly calendar. R package version 0.0.0.9000, https://github.com/frbcesab/calendar.","code":"@Manual{, title = {calendar: {An} {R} package to create a monthly calendar}, author = {{Casajus Nicolas}}, year = {2024}, note = {R package version 0.0.0.9000}, url = {https://github.com/frbcesab/calendar}, }"},{"path":"https://frbcesab.github.io/calendar/index.html","id":"calendar-","dir":"","previous_headings":"","what":"Create a Monthly Calendar with Events","title":"Create a Monthly Calendar with Events","text":"• Overview • Installation • Get started • Citation • Contributing • Acknowledgments","code":""},{"path":"https://frbcesab.github.io/calendar/index.html","id":"overview","dir":"","previous_headings":"","what":"Overview","title":"Create a Monthly Calendar with Events","text":"R package calendar dedicated create monthly calendar. plots exports calendar pdf file (ready print A4 paper format). Holidays (France supported yet) identified user can easily add events (four day). User can also choose week five days (working week) full week (weekend included). Empty monthly calendar (weekends) Empty monthly calendar (without weekend) Monthly calendar single-day events Monthly calendar multi-day events Monthly calendar multi-week events --one","code":""},{"path":"https://frbcesab.github.io/calendar/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Create a Monthly Calendar with Events","text":"can install development version GitHub : can attach package calendar:","code":"## Install < remotes > package (if not already installed) ---- if (!requireNamespace(\"remotes\", quietly = TRUE)) { install.packages(\"remotes\") } ## Install < calendar > from GitHub ---- remotes::install_github(\"frbcesab/calendar\") library(\"calendar\")"},{"path":"https://frbcesab.github.io/calendar/index.html","id":"get-started","dir":"","previous_headings":"","what":"Get started","title":"Create a Monthly Calendar with Events","text":"overview main features calendar, please read Get started vignette.","code":""},{"path":"https://frbcesab.github.io/calendar/index.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Create a Monthly Calendar with Events","text":"Please cite calendar : Casajus Nicolas (2024) calendar: R package create monthly calendar. R package version 0.0.0.9000. https://github.com/frbcesab/calendar/","code":""},{"path":"https://frbcesab.github.io/calendar/index.html","id":"contributing","dir":"","previous_headings":"","what":"Contributing","title":"Create a Monthly Calendar with Events","text":"types contributions encouraged valued. information, check Contributor Guidelines. Please note calendar project released Contributor Code Conduct. contributing project, agree abide terms.","code":""},{"path":"https://frbcesab.github.io/calendar/index.html","id":"acknowledgments","dir":"","previous_headings":"","what":"Acknowledgments","title":"Create a Monthly Calendar with Events","text":"package developed part FRB-CESAB work.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/calendar-package.html","id":null,"dir":"Reference","previous_headings":"","what":"calendar: Create a Monthly Calendar with Events — calendar-package","title":"calendar: Create a Monthly Calendar with Events — calendar-package","text":"Plots exports monthly calendar 'pdf'. Holidays (France ) identified. User can easily add events (four day) choose week five days (working week) full week (weekend included).","code":""},{"path":[]},{"path":"https://frbcesab.github.io/calendar/reference/calendar-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"calendar: Create a Monthly Calendar with Events — calendar-package","text":"Maintainer: Nicolas Casajus nicolas.casajus@fondationbiodiversite.fr (ORCID) [copyright holder]","code":""},{"path":"https://frbcesab.github.io/calendar/reference/filter_events.html","id":null,"dir":"Reference","previous_headings":"","what":"Filter calendar events to match the extent on the calendar — filter_events","title":"Filter calendar events to match the extent on the calendar — filter_events","text":"Filter calendar events match extent calendar","code":""},{"path":"https://frbcesab.github.io/calendar/reference/filter_events.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Filter calendar events to match the extent on the calendar — filter_events","text":"","code":"filter_events( data, year = format(Sys.Date(), \"%Y\"), month = format(Sys.Date(), \"%m\"), format = \"%Y-%m-%d\", weekend = FALSE )"},{"path":"https://frbcesab.github.io/calendar/reference/filter_events.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Filter calendar events to match the extent on the calendar — filter_events","text":"data data.frame least following columns: , start event, , end event, event, name event, category, category event (used different colors). year either integer character length 1. Must 4 characters (e.g. '2024' '24'). Default current year. month either integer character length 1. Must 1 2 characters (e.g. '01' '1'). Default current month. format character length 1. Used specify format date. Default \"%Y-%m-%d\" (.e. 2024-12-25). weekend logical. TRUE keeps Saturdays Sundays. Default FALSE.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/filter_events.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Filter calendar events to match the extent on the calendar — filter_events","text":"data.frame, input events matching extent calendar.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/filter_events.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Filter calendar events to match the extent on the calendar — filter_events","text":"","code":"## No example ---"},{"path":"https://frbcesab.github.io/calendar/reference/get_calendar.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the calendar for a given month and year — get_calendar","title":"Get the calendar for a given month and year — get_calendar","text":"Get calendar given month year","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_calendar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the calendar for a given month and year — get_calendar","text":"","code":"get_calendar( year = format(Sys.Date(), \"%Y\"), month = format(Sys.Date(), \"%m\"), weekend = FALSE, lang = NULL )"},{"path":"https://frbcesab.github.io/calendar/reference/get_calendar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the calendar for a given month and year — get_calendar","text":"year either integer character length 1. Must 4 characters (e.g. '2024' '24'). Default current year. month either integer character length 1. Must 1 2 characters (e.g. '01' '1'). Default current month. weekend logical. TRUE keeps Saturdays Sundays. Default FALSE. lang character length 1. Used change default locale (.e. language). Default NULL (.e. use current locale). See examples . Depending OS locale, output can weird.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_calendar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the calendar for a given month and year — get_calendar","text":"data.frame following columns: date: date day (YYYY-MM-DD), year: year day (integer), month: month day (integer), day: day (integer), week: number week (integer), weekday: name day week (character), month_name: name month (character), x: position x-axis (used plot_calendar()), y: position y-axis (used plot_calendar()).","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_calendar.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get the calendar for a given month and year — get_calendar","text":"","code":"## Calendar for the current month ---- head(get_calendar()) #> date year month day week en_weekday en_month_name user_weekday #> 1 2024-03-01 2024 3 1 9 Friday March Friday #> 2 2024-03-04 2024 3 4 10 Monday March Monday #> 3 2024-03-05 2024 3 5 10 Tuesday March Tuesday #> 4 2024-03-06 2024 3 6 10 Wednesday March Wednesday #> 5 2024-03-07 2024 3 7 10 Thursday March Thursday #> 6 2024-03-08 2024 3 8 10 Friday March Friday #> user_month_name x y #> 1 March 5 6 #> 2 March 1 5 #> 3 March 2 5 #> 4 March 3 5 #> 5 March 4 5 #> 6 March 5 5 ## Calendar for December (current year) ---- head(get_calendar(month = 12)) #> date year month day week en_weekday en_month_name user_weekday #> 1 2024-12-02 2024 12 2 49 Monday December Monday #> 2 2024-12-03 2024 12 3 49 Tuesday December Tuesday #> 3 2024-12-04 2024 12 4 49 Wednesday December Wednesday #> 4 2024-12-05 2024 12 5 49 Thursday December Thursday #> 5 2024-12-06 2024 12 6 49 Friday December Friday #> 6 2024-12-09 2024 12 9 50 Monday December Monday #> user_month_name x y #> 1 December 1 6 #> 2 December 2 6 #> 3 December 3 6 #> 4 December 4 6 #> 5 December 5 6 #> 6 December 1 5 ## Calendar for April (current year) ---- head(get_calendar(month = 4)) #> date year month day week en_weekday en_month_name user_weekday #> 1 2024-04-01 2024 4 1 14 Monday April Monday #> 2 2024-04-02 2024 4 2 14 Tuesday April Tuesday #> 3 2024-04-03 2024 4 3 14 Wednesday April Wednesday #> 4 2024-04-04 2024 4 4 14 Thursday April Thursday #> 5 2024-04-05 2024 4 5 14 Friday April Friday #> 6 2024-04-08 2024 4 8 15 Monday April Monday #> user_month_name x y #> 1 April 1 6 #> 2 April 2 6 #> 3 April 3 6 #> 4 April 4 6 #> 5 April 5 6 #> 6 April 1 5 ## Calendar for January 1970 ---- head(get_calendar(year = 1970, month = 1)) #> date year month day week en_weekday en_month_name user_weekday #> 1 1970-01-01 1970 1 1 0 Thursday January Thursday #> 2 1970-01-02 1970 1 2 0 Friday January Friday #> 3 1970-01-05 1970 1 5 1 Monday January Monday #> 4 1970-01-06 1970 1 6 1 Tuesday January Tuesday #> 5 1970-01-07 1970 1 7 1 Wednesday January Wednesday #> 6 1970-01-08 1970 1 8 1 Thursday January Thursday #> user_month_name x y #> 1 January 4 6 #> 2 January 5 6 #> 3 January 1 5 #> 4 January 2 5 #> 5 January 3 5 #> 6 January 4 5 if (FALSE) { ## Change the locale (Spanish) ---- head(get_calendar(year = 1970, month = 1, lang = \"Spanish\")) }"},{"path":"https://frbcesab.github.io/calendar/reference/get_month_name.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the name of a month — get_month_name","title":"Get the name of a month — get_month_name","text":"Get name month","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_month_name.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the name of a month — get_month_name","text":"","code":"get_month_name(month, lang = NULL)"},{"path":"https://frbcesab.github.io/calendar/reference/get_month_name.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the name of a month — get_month_name","text":"month integer length 1. month convert letters. lang character length 1. Used change default locale (.e. language). Default NULL (.e. use current locale). See examples . Depending OS locale, output can weird.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_month_name.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the name of a month — get_month_name","text":"character length 1.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_month_name.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get the name of a month — get_month_name","text":"","code":"## Default ---- get_month_name(month = 4) #> [1] \"April\" if (FALSE) { ## Get Spanish name ---- get_month_name(month = 4, lang = \"Spanish\") ## Get Finnish name ---- get_month_name(month = 4, lang = \"Finnish\") }"},{"path":"https://frbcesab.github.io/calendar/reference/get_moon_phases.html","id":null,"dir":"Reference","previous_headings":"","what":"Get moon phases for a given year — get_moon_phases","title":"Get moon phases for a given year — get_moon_phases","text":"Scraps site https://www.timeanddate.com retrive moon phases data.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_moon_phases.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get moon phases for a given year — get_moon_phases","text":"","code":"get_moon_phases(year)"},{"path":"https://frbcesab.github.io/calendar/reference/get_moon_phases.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get moon phases for a given year — get_moon_phases","text":"year either integer character length 1. Must 4 characters (e.g. '2024' '24'). Default current year.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_moon_phases.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get moon phases for a given year — get_moon_phases","text":"data.frame following columns: new_moon: date new moons (YYYY-MM-DD), full_moon: date full moons (integer).","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_moon_phases.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get moon phases for a given year — get_moon_phases","text":"","code":"## Get moon phases for 2024 ---- get_moon_phases(2024) #> Error in `$<-.data.frame`(`*tmp*`, \"new_moon\", value = \" 2024\"): replacement has 1 row, data has 0"},{"path":"https://frbcesab.github.io/calendar/reference/get_weekday_name.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the weekday name of a date — get_weekday_name","title":"Get the weekday name of a date — get_weekday_name","text":"Get weekday name date","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_weekday_name.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the weekday name of a date — get_weekday_name","text":"","code":"get_weekday_name(date, format = \"%Y-%m-%d\", lang = NULL)"},{"path":"https://frbcesab.github.io/calendar/reference/get_weekday_name.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the weekday name of a date — get_weekday_name","text":"date either character Date length 1. date extract weekday name. See examples . format character length 1. Used specify format date. Default \"%Y-%m-%d\" (.e. 2024-12-25). See examples . lang character length 1. Used change default locale (.e. language). Default NULL (.e. use current locale). See examples . Depending OS locale, output can weird.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_weekday_name.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the weekday name of a date — get_weekday_name","text":"character length 1.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/get_weekday_name.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get the weekday name of a date — get_weekday_name","text":"","code":"## Default ---- get_weekday_name(\"2024-04-01\") #> [1] \"Monday\" ## Change date format ---- get_weekday_name(\"01/04/2024\", format = \"%d/%m/%Y\") #> [1] \"Monday\" if (FALSE) { ## Get Spanish name ---- get_weekday_name(\"2024-04-01\", lang = \"Spanish\") ## Get Finnish name ---- get_weekday_name(\"2024-04-01\", lang = \"Finnish\") }"},{"path":"https://frbcesab.github.io/calendar/reference/number_of_days.html","id":null,"dir":"Reference","previous_headings":"","what":"Return the number of days in a month for a given year — number_of_days","title":"Return the number of days in a month for a given year — number_of_days","text":"Return number days month given year","code":""},{"path":"https://frbcesab.github.io/calendar/reference/number_of_days.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Return the number of days in a month for a given year — number_of_days","text":"","code":"number_of_days(date, format = \"%Y-%m-%d\")"},{"path":"https://frbcesab.github.io/calendar/reference/number_of_days.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Return the number of days in a month for a given year — number_of_days","text":"date either character Date length 1. See examples . format character length 1. Used specify format date. Default \"%Y-%m-%d\" (.e. 2024-12-25). See examples .","code":""},{"path":"https://frbcesab.github.io/calendar/reference/number_of_days.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Return the number of days in a month for a given year — number_of_days","text":"integer corresponding number days month specified year.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/number_of_days.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Return the number of days in a month for a given year — number_of_days","text":"","code":"## Default ---- number_of_days(\"2024-02-01\") #> [1] 29 ## Day doesn't matter ---- number_of_days(\"2024-02-23\") #> [1] 29 ## Year matters ---- number_of_days(\"2023-02-23\") #> [1] 28 ## Change the format ---- number_of_days(\"2024/02/23\", format = \"%Y/%m/%d\") #> [1] 29 ## French format ---- number_of_days(\"23/02/2024\", format = \"%d/%m/%Y\") #> [1] 29"},{"path":"https://frbcesab.github.io/calendar/reference/plot_calendar.html","id":null,"dir":"Reference","previous_headings":"","what":"Export a monthly calendar as pdf — plot_calendar","title":"Export a monthly calendar as pdf — plot_calendar","text":"Export monthly calendar pdf","code":""},{"path":"https://frbcesab.github.io/calendar/reference/plot_calendar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Export a monthly calendar as pdf — plot_calendar","text":"","code":"plot_calendar( year = format(Sys.Date(), \"%Y\"), month = format(Sys.Date(), \"%m\"), path = getwd(), filename = NULL, title = NULL, events = NULL, weekend = FALSE, palette = \"#990000\", lang = NULL, moon = TRUE )"},{"path":"https://frbcesab.github.io/calendar/reference/plot_calendar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Export a monthly calendar as pdf — plot_calendar","text":"year either integer character length 1. Must 4 characters (e.g. '2024' '24'). Default current year. month either integer character length 1. Must 1 2 characters (e.g. '01' '1'). Default current month. path character length 1. directory save pdf file. Must exist. Default current directory. filename character length 1. name pdf file. Default calendar-YYYY-MM.pdf (e.g. calendar-2024-04.pdf). title character length 1. title calendar. Default Month YYYY (e.g. April 2024). events optional data.frame following columns: event, name event, , starting date event, , ending date event, category, category event. weekend logical. TRUE keeps Saturdays Sundays. Default FALSE. palette character vector colors events. one color provided (default), events color. several colors provided, number colors palette must equal total number event categories (duplicated colors accepted). Moreover, palette argument must named vector, names match event categories. example, events object contains two categories (cat_a cat_b), palette argument must equal palette = c(\"cat_a\" = \"black\", \"cat_b\" = \"red\"). lang character length 1. Used change default locale (.e. language). Default NULL (.e. use current locale). See examples . Depending OS locale, output can weird. moon logical. TRUE (default) adds new/full moon glyph.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/plot_calendar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Export a monthly calendar as pdf — plot_calendar","text":"return value. calendar exported pdf file path.","code":""},{"path":"https://frbcesab.github.io/calendar/reference/plot_calendar.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Export a monthly calendar as pdf — plot_calendar","text":"","code":"if (FALSE) { ## Add an example ---- }"},{"path":[]}] diff --git a/sitemap.xml b/sitemap.xml index b050efd..ebf5cdd 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -39,6 +39,9 @@ https://frbcesab.github.io/calendar/reference/get_month_name.html + + https://frbcesab.github.io/calendar/reference/get_moon_phases.html + https://frbcesab.github.io/calendar/reference/get_weekday_name.html