From 20cd4457229cfd7be22a40c1b9653fa1f5f1072a Mon Sep 17 00:00:00 2001 From: Nicolas Casajus Date: Fri, 29 Mar 2024 10:30:24 +0100 Subject: [PATCH] doc: edit documentation --- DESCRIPTION | 2 +- README.Rmd | 22 +++------------------- README.md | 27 ++++++++------------------- man/figures/calendar-2024-04.pdf | Bin 0 -> 4636 bytes 4 files changed, 12 insertions(+), 39 deletions(-) create mode 100644 man/figures/calendar-2024-04.pdf diff --git a/DESCRIPTION b/DESCRIPTION index cd0594b..f3030f3 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: calendar Type: Package -Title: Create a Monthly Calendar +Title: Create a Monthly Calendar with Events Version: 0.0.0.9000 Authors@R: c( person(given = "Nicolas", diff --git a/README.Rmd b/README.Rmd index 8ae2ef4..60caeb3 100644 --- a/README.Rmd +++ b/README.Rmd @@ -27,14 +27,11 @@ calendar • Overview
- • Features
• Installation
• Get started
- • Long-form documentations
• Citation
• Contributing
- • Acknowledgments
- • References + • Acknowledgments

@@ -42,13 +39,10 @@ calendar • Overview
• -Features
• Installation
• Get started
• -Long-form documentations
• Citation
• Contributing
• -Acknowledgments
• -References +Acknowledgments

## Overview -The R package `calendar`… **{{ DESCRIBE YOUR PACKAGE }}** +The R package `calendar` is dedicated to create a monthly calendar. It +plots and exports the calendar as a `pdf` file (ready to print in the A4 +paper format). Holidays (only France is supported yet) are identified +and user can easily add events (up to four by day). User can also choose +between of a week of five days (working week) or a full week (weekend +included). -## Features - -The main purpose of `calendar` is to… **{{ DESCRIBE THE MAIN FEATURES -}}** +![](man/figures/calendar-2024-04.pdf) ## Installation @@ -60,16 +59,6 @@ For an overview of the main features of `calendar`, please read the [Get started](https://frbcesab.github.io/calendar/articles/calendar.html) vignette. -## Long-form documentations - -`calendar` provides **{{ NUMBER OF VIGNETTES }}** vignettes to learn -more about the package: - -- the [Get - started](https://frbcesab.github.io/calendar/articles/calendar.html) - vignette describes the core features of the package -- **{{ LIST ADDITIONAL VIGNETTES }}** - ## Citation Please cite `calendar` as: diff --git a/man/figures/calendar-2024-04.pdf b/man/figures/calendar-2024-04.pdf new file mode 100644 index 0000000000000000000000000000000000000000..e839a04d516da6c8d305411958c1cfabc930ad2c GIT binary patch literal 4636 zcmb7Ic{r5q+g3uRvM+gwCs{_8S!`pA7&~FekR{U?OpTdomJHdACFBjIlwC;jlaQ>X zvXp&|C`$`jqDZ3h&3NB>mww-O9N+WT^PKl}-Pe8JGv|3+=PhrKG*gACX@KM-rXpTN zbVu~NQ$R2P3Xo2m1nKL8ASM(XhK45*kr)~d03&tbP`CzE9j*g|!Vz$U5(r{T^8R1P zobWUPD+>jfQ!r#dJeCUB(P?Bljg@9kA$ilWI0}1ILrq;xorP`HBC#PQ(4j*h9MPM- z3i!{}01&4@G7f;4U}zWu$rpgwV|;N`K%EtU0{%+S{w0AO$Bw4ph_pY$AtodujrBuiuXEXfF{Bcn6D`_w2@Bz*C^^2=Twn|_jYYk@|Tk#_CgAg}>b0juhE_xT>|=C`cU%b%(W z{C9J{lYRAg(coR`D?4WqmBUS{V@IdSJO_6w74PXgC(u*_riBxCiQg`H`T6*vuF2Xm z5zk2UoxArB1&7?ZdA(;%kc3vuUUHnC44?;c329x5!9^D+%g0iDFA&DO~jC9-WF@;(gD;r9g8NDIoU66wdZzasLUMb^9 zOCc!-ol~$Bqz_V#H|a*k;9g5vb=j01=CqYiLCeTiEn)d4Z2Jf8*sN!Qpf5ew($svF z-z>={iwY=33c~x(ppuF=XU83ew4~I3qIK9>z*c^xgeF_#(Kqq^FMO?)2dCE*s5k z7BBz&kN?R~HUa-2$Pb48K}?7>-kS=z0c=8|01p;%NpuzgVF1Jy=Z(i0lNf*-lr@IX zfB~91njU}SFq?xvILDF-tRs#FxItKA#j1c~&^$m8GZudVeSL_THUMK!f?^R70l?VW zwIv1+QwGi4k;axSeSP-Ktm*_3#gUA`ZXpmV%G?;x{1N__e6S&QX*Y|@)_>Is_L_cbMP^!nljDe3 zYfqI+2kM$%Q-N;EC{jljL&Q_~>m8 z<#RhEkOQa5B9dvA-lY=b^?{3>*T!W&hn~uA=zih57&27Lap7we*Fzf@-tgVIE+UiD z&2i@we7$(K?Ox*GBydcSD=Lh|*37o2Zx0?$B%}+ki8s{p0be!__8TTPacpK^tZ|iv zaoAr;oc_2r;w~Zn1Yv;Akgv9Ta^j*U_CVNSUPw!l-fj25(qiB{fMlGb*?G}8G(PD|GYd!imssrV|FjE%WlZ_7TV1esY} z&*lp=IUd}NYJ9Qy2E$lRMWoPRCZ5_vpP)kI9T@|WFjvt!p}c)ru6#RR{~HO4_M znj+f^Z2+6JDz`S_IIeW#7^Ai9t84s^zF!}yNjvv^O|U1;WqZN?-;6?~Ilu=60p7FT z$~}uAyIRaSzjP+_reDe2=#Kmzg1%?-y-iFmED39lgx?c#=$gO!_1Ja|fWy>?bJj?5 zhEw>#j=K*8?{V-?aBe>gj@xnC3pNoca$y@15Elur%GrA{veZlQ1~)xNP$No6g<)Cgz-He&d^_g*-0n>h~<=A6Vo#Wsqv@RONa{$U)*mUf+Ac3pG%MP(Ki7DRn zWC@OtQH!j8aEZ(rEbyLb_vrG3pbN+_qDU}YKu|X?0V*i=(9AfQA;&AYzvP0@_3e10 z=NF`}%hbeMBp0>0iEx{m!t8A>?s_UC8a ziI~E2ms`3+QgiWpnklzW5MXyfX9dm*o#oO?3W+)}MI+xu9Cz105~uw5=)^IyA{k8< zz9&&H^ip6kk-vF)sr>_P%`BKdbf;lb_I|K%BJY2g7RCoLs<|mWW(ezh){Mh)LZ9M} zJSOLb--~gv)JN*uNy#_LJ6QP0X(>g>?f2impqMH9Lbd@&ePZU#PtkX^d1*{k$lgD$ zc;6xCpv%D>;3W}fq?nRE(3Ym;zO~J=M#%_rH>ts6*%S7 zoZiLsRl<*snCUp_m;_c(5bchFUfPKMOC+1B%oMX)ZeZXwibr!M5 zM7@x!2Zb-FB>6>EDv8F&XIfQSWm%nndRkOzU#?^?=ghkm_&R2tzOHvv^{Cy^##x0y ztwH6RWrJ^T1m5^CXf^PB&}`skvHC#BK>t8>aX|5SzY+clo_Xr^$@yMH$p;#re^R^D z`-~Kw*y*t$re>$c0S&a@`+ljOjG?}vkNr>kZuaTse{#C^pM~7an++x#%+>3BM_X;p zb1F=xuXkZ%K#x+ByKZ=|zzS)a^lxT~yx?&CEj z(`ULvh`z+u>QQV!f7VHv6Ze}MpM8&t%8zQx?Zou;K7jR>4}IWHXaQmUeKG@#^#XND z&*;8g85(JFoev)VA}(HNebqXlJwLEzd2RW(>GL(SH5B(bj{@TEYGic-5f$JOkaRX` zgOfjmKg&F|m048mdvp45x3A}rr)(Kt*)xLgs@19z>G5cH-Q%-8u~Wit92cnL=x*(i z>cN1g-7iVe<4R$bVHY;FHYK+m+cp;dHoVxV^}(fxki*w=xDF2<=8x=*G;K22Pqy%C zTfI=Xyk~mXbU<`uPk7Hl?&pVzkJ6$;WRiIKca`ym?ZpT?2=v|$ul0HonZ{Kn+aTL6 zyNFCjTIL1ii{=aGUCTe-%4ogVYJn|1fo}1P?~fCHOmD@$%71ljsz`iYWvqs*-*hM! zF}W`L$}})RO=ZX>qj7Cbs98Qk-dw2n9PFIxxka7a4DPO#zVL!7>!N#v_iFEjvv^26 zq?E;{kZC))8ih-W23BWmUuNm2Pi3K!KRP`SbJ~?vv|cn+(0F8*?P&I@l7T{l0q5o9 zE2o_-1PggL;8p6&@Ysruiuj7_?HQLB+_mIELYg>}k%T*S%^D-!1L2R6cRb-&U!^&w zE-Ps3ezwS>WI;(@H6tHw+Z8{CEZ_HxIM(FR>z3no`>q$QVEXC$(Vm+HB|+%9GPPp{ zjV+|kh$?0k{!|#aQcVRCT%+dWVVCUOdo{28Q|O#qf@r*Hv$obf!i~|m=ip()J^cH^ zo3=9640&RKw>xqP-Oe4(lS6Z(W7Ye>Xti#L%&7F8 z1}YEM{7KSfz033U_87E7b;51yJJ!b}+($fc_ElB0A#|%x7U$8nXG?t+3ZFl#3#==f z|1jL|TyzwD>@%^+8WFJ;>vfALMKDtMZ|H2 zbS8Cns$Nyam6A)Y(?5DWY-%58g!R8@A(W7csxM1#kCls+4!gFt@afUv*t5UiPO1#? zUGwngsmi}DJnQ~aXYf*={6f;4^r7DvmDQ~UMX%1bFMgKkH*lu9zhR8o7jIWkMsp&<{hRU1n8y&Al0`4=u!l9yin%~`5 zzV?@0JAUK-@Mhn8+#+pw(=?%hJya|#im4-2gMUv#+co<{`G~%6Au%q_#XfWg2emy;8##QZFHBvXb&K&&3<`(+7fk0D zOalsM`KN#8YQTP7vj!Z_vOz!MXcP>dfTOUkZ~%xSJ_yG;0{~)4^dYg_*Opg8kw`Rv ceYLXni%@A83T^AOG}K`Tki5L9of+tV05B)kfdBvi literal 0 HcmV?d00001