From 49219a4d39f00a38ad7a6a5a024b0c8650812eb0 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 5 Mar 2024 00:10:36 +0000 Subject: [PATCH] source commit: 167b5b29f9e6da2f4b2d041371fa5d36e916eba4 --- CODE_OF_CONDUCT.md | 13 + LICENSE.md | 79 +++++ config.yaml | 78 +++++ fig/introduction-rendered-pyramid-1.png | Bin 0 -> 4841 bytes index.md | 9 + instructor-notes.md | 5 + introduction.md | 131 ++++++++ learner-profiles.md | 5 + links.md | 10 + md5sum.txt | 12 + reference.md | 8 + renv.lock | 407 ++++++++++++++++++++++++ setup.md | 54 ++++ 13 files changed, 811 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 LICENSE.md create mode 100644 config.yaml create mode 100644 fig/introduction-rendered-pyramid-1.png create mode 100644 index.md create mode 100644 instructor-notes.md create mode 100644 introduction.md create mode 100644 learner-profiles.md create mode 100644 links.md create mode 100644 md5sum.txt create mode 100644 reference.md create mode 100644 renv.lock create mode 100644 setup.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..f19b8049 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,13 @@ +--- +title: "Contributor Code of Conduct" +--- + +As contributors and maintainers of this project, +we pledge to follow the [The Carpentries Code of Conduct][coc]. + +Instances of abusive, harassing, or otherwise unacceptable behavior +may be reported by following our [reporting guidelines][coc-reporting]. + + +[coc-reporting]: https://docs.carpentries.org/topic_folders/policies/incident-reporting.html +[coc]: https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..7632871f --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,79 @@ +--- +title: "Licenses" +--- + +## Instructional Material + +All Carpentries (Software Carpentry, Data Carpentry, and Library Carpentry) +instructional material is made available under the [Creative Commons +Attribution license][cc-by-human]. The following is a human-readable summary of +(and not a substitute for) the [full legal text of the CC BY 4.0 +license][cc-by-legal]. + +You are free: + +- to **Share**---copy and redistribute the material in any medium or format +- to **Adapt**---remix, transform, and build upon the material + +for any purpose, even commercially. + +The licensor cannot revoke these freedoms as long as you follow the license +terms. + +Under the following terms: + +- **Attribution**---You must give appropriate credit (mentioning that your work + is derived from work that is Copyright (c) The Carpentries and, where + practical, linking to ), provide a [link to the + license][cc-by-human], and indicate if changes were made. You may do so in + any reasonable manner, but not in any way that suggests the licensor endorses + you or your use. + +- **No additional restrictions**---You may not apply legal terms or + technological measures that legally restrict others from doing anything the + license permits. With the understanding that: + +Notices: + +* You do not have to comply with the license for elements of the material in + the public domain or where your use is permitted by an applicable exception + or limitation. +* No warranties are given. The license may not give you all of the permissions + necessary for your intended use. For example, other rights such as publicity, + privacy, or moral rights may limit how you use the material. + +## Software + +Except where otherwise noted, the example programs and other software provided +by The Carpentries are made available under the [OSI][osi]-approved [MIT +license][mit-license]. + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +## Trademark + +"The Carpentries", "Software Carpentry", "Data Carpentry", and "Library +Carpentry" and their respective logos are registered trademarks of [Community +Initiatives][ci]. + +[cc-by-human]: https://creativecommons.org/licenses/by/4.0/ +[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode +[mit-license]: https://opensource.org/licenses/mit-license.html +[ci]: https://communityin.org/ +[osi]: https://opensource.org diff --git a/config.yaml b/config.yaml new file mode 100644 index 00000000..f711a90d --- /dev/null +++ b/config.yaml @@ -0,0 +1,78 @@ +#------------------------------------------------------------ +# Values for this lesson. +#------------------------------------------------------------ + +# Which carpentry is this (swc, dc, lc, or cp)? +# swc: Software Carpentry +# dc: Data Carpentry +# lc: Library Carpentry +# cp: Carpentries (to use for instructor training for instance) +# incubator: The Carpentries Incubator +carpentry: 'incubator' + +# Overall title for pages. +title: 'Lesson Title' # FIXME + +# Date the lesson was created (YYYY-MM-DD, this is empty by default) +created: ~ # FIXME + +# Comma-separated list of keywords for the lesson +keywords: 'software, data, lesson, The Carpentries' # FIXME + +# Life cycle stage of the lesson +# possible values: pre-alpha, alpha, beta, stable +life_cycle: 'pre-alpha' # FIXME + +# License of the lesson +license: 'CC-BY 4.0' + +# Link to the source repository for this lesson +source: 'https://github.com/carpentries/workbench-template-rmd' # FIXME + +# Default branch of your lesson +branch: 'main' + +# Who to contact if there are any issues +contact: 'team@carpentries.org' # FIXME + +# Navigation ------------------------------------------------ +# +# Use the following menu items to specify the order of +# individual pages in each dropdown section. Leave blank to +# include all pages in the folder. +# +# Example ------------- +# +# episodes: +# - introduction.md +# - first-steps.md +# +# learners: +# - setup.md +# +# instructors: +# - instructor-notes.md +# +# profiles: +# - one-learner.md +# - another-learner.md + +# Order of episodes in your lesson +episodes: +- introduction.Rmd + +# Information for Learners +learners: + +# Information for Instructors +instructors: + +# Learner Profiles +profiles: + +# Customisation --------------------------------------------- +# +# This space below is where custom yaml items (e.g. pinning +# sandpaper and varnish versions) should live + + diff --git a/fig/introduction-rendered-pyramid-1.png b/fig/introduction-rendered-pyramid-1.png new file mode 100644 index 0000000000000000000000000000000000000000..73615445773ef9c207442f2c7f40e973c35a5958 GIT binary patch literal 4841 zcmds*X;4$yw#UOHV8Eb^iUb8EwuliCB8EW>5Cjnwm1YtY6htMA5=a6vUz#BzA}SCX zgN@2$OG_972{I2MBA^T*X@~?6atKHw;|txdUfsG?@58+x?}z>SpS4cyb#~P`wf}pa zlndw4ire>W2Z2C}XYH&nfj|{MMYIrRZUGzU0q#6Lu1dL zJ(`-Dd-v|u($a!Lq1xKo`}XbA(b3V>)je?Fz`=tD_4M>$Fxa6(hYlY;tgo+sbW5U3Q#U&&pBqk;%B_$;%C#R&O{PN2$si~=H zX=&-{=@}UrL?SUWGczkI>+$2q+1c4oo;=CP$$9qd+4JYmb8~a^^72R|Qek1?ix)4* zWO7ka(aV=Fi;Ih2zkdDZ&6|>vlG4)B^78VEii&sd-c?qDDl04h_~VbNswxVFQe9nL zQ&Ur0TU%FG*U-?=*w{#;(dcw~b93{D4-JtI7 z?w%e{Pft&8Z!d$v=U6T zIULTPfBrc!F)=wg$>nmteg%E~`gLk*ipS$kPfyRx%*@Wte*5-qZfRN?%()z{)f#+!yUR{%U1uc;<1;&3talnP zKYg@U?(e)*=@sCnQTWnE=5V2F(d{R0dVjb*wDom+YI|5ksczizH4+)IJk>ph^P68c zE8r7ILeuWUMxl&|f}C&fNTJ2jHeXbhBvkZhS$f!y(oWCWXO+!v$H5$dB6-q@|E6TR z?8Xl;G5>v-!{<{Ff|B+^6Z~hKzc*@pHV$Je)fm%R(lN0dFTb|Ir5JqCp#Rq2=Xb_d zO8csT>!!V6e{AFO^Ps7l`#lKyD|YQzwy@09Z}`u2`L$YAS$bD8-!!b-fv3BFBGzfR zj>>;sM(D3Nx3Msa(?&`W_WGXykO*Ta{AbE{UjCxC9ESw)jFDZj>+@$*oEkUTO=Kg= z!SRWLrwz#Z;K^_KJY6etEX2K+WO`>h9%b1UvrOLaQLjMQch?M|9N^=hIpO$ho)3oIvq2D?}V-@4YilkBUEYn5}cDibv#j4wJ5hf*9St*h~(uJcBWEHEbr|gUOpa z-QU?vz7A6~zi^95CtnFog#JYSnZqnHMKM0r*m0P@)}SB*zaQc-pC_In4isu|n2%*p zi~*_~hxsrO1sSXov6*R}38Yd_CXKwaZo9c#u1-7}d|xw)lF}kWT%O&(6gH8%9hyGm z%v)$xRW^HG-qyF6ZlHrb;lU`B-Ro=y_*d;Z<8-ptpUw1tnE(yG{Cg9*!+yK@gk5G6 znPv|*p9~6aBG=d}nBOcp#Ag0{Gl})?iUQzY5`wCDriWeZ3pGgvK^3n=@vM>s5aO*j z`<9B*N1Mr+hvm%!00>d<&7q~zc@FdRl|IxU^iIj`gu`&=v#9L?ViGR4h zO(f9Crr+Wmk6?pdrFhcGhUcX29l?hEnr==f|CH98_Du<@cwOt(P1;0!={E?p$6MR? z77Zz9Sc$}*kUY@T8z)rq_QL@Fk{6ayV3y4?3K@@T8df)piuU;G3}&4j zbgqj-6N%kXcWAf{?B8$#c+<2m83tIymy9_%sJYpxk@qruSpVNxZzB6eJmikXMLgz? z2C|uCTzd$HhU*Oa8*qTvLGV3U&Gx*B_$Mf1m)L>F-8}&6|6)|uEGp3Qnd4EcpX)zi zUJ`0vRa|PKUQbE;R|r8w(y)sy8O-uD`BxwxpdoVxxdSr%qg#My{r^}1c+b{v9{-6ywACzetVwNHl{2#y#{r@p^WKrU16oZJlc7ygllN@>lK8xgY|8F@4U1;NiTaxQ z9$s7o3}bW(j{j{{1M3r+%e>909E%m$l5r1`+nu&SvJk_0s?nE(zXM4E+uSU=)BFx` z$^$Uv^h~CkL`Yzc7PM&{z!;kz#9Ig#029I0EF=0x$C$~pUy&fJ}*)q)r*HB_BuCfAyVZbdx%V-aGZksy(y6CW2Ve#;pKm!b- zS{!aCNbWhy2d5ORSJUT7B#M!lcfgyC?7-8a*kqZtJv%9x#f=H%@l_gg>df;-Iw-yjfc3$l2FFv2hWMI5?UW6|haTYg9i6Q828I zHx^_!=j_8!Pe|Z@npf=_fzK&WC4W2`t>oacDcZHmz|9($!w`*OP5iXrDq!9rb-x^m zkDOQS)V+US)~g)MDtwzB=}hD@lA?R#Ss?%8NWkS0xuDX5( zGG(jP6VZ^9zx{)4#N9bB!)1znL{D@iaue9H7FE1oWEyT~WXje~iPt|^E@Hzvk;!QOmaVn*qsCx4XtCEF z;>7C;JJ?L;@WbatY&i>esQKkKokU3VXeFDee^W&tp9(Ewy^3GKM5mDsm0&sX>caCt zqs6T1lJ#yI1?~DKN)CiW(TBW%&3JSJ`+sfeKSjVbu3ud`ou8`7D#I^^N#$6iuu>&g;f!9%Vq39}f+(1J$bv#SFoVPm3In=o6y(74!Lzr*Q(CvuTy zhV%8jQM9KC_mIzq(qmhjzbqSdItdIjZ`8=EV%=d z!K<{58n5TbsZ1rRQOvxcF#&ilG}!2@f9vZbmwVoUw8_tg^)}qVOc3uZro4@0rs&^? zczQR#hQT*|s>5dJJ^RhpH)ea0>*~`ZB;~?&$UEu@!FaI;-PNqsY8xxnwUmb z!phv^E-CK2C0K27jb{7p}hzui1FrsNj;fQb0i0p9)DSoss09 zq4s}S{`+8AxY@2$m9Io+DMi0MURrk`0sS>G2QnVYdz$k|-8^~}wVFh=Ds~!eIG#XZ zHCRS|ty72PJYC_dMB55l*7ECeF|(Fy7iL4&(aAxJ#i*0hHJJ{+S2VFF2uV0{!|W<4 z08ey^R>c2Ed%5V6P!X;3qc)$NhvWPBDKz*t3#MHf@?X7l8XZLV_2%tPuTY^}%QoA) zaAUhAERr|E#Jg|eP~zep{P7T!9JpY2jrCRIINAOPi@{#U^fvI|OF#%8R-Sj?NzKRa z9?xTsE*8%6?Yu+`RSGO%T6uiaZgyRG?W0I}^Vas552rsPxbMG?>~T2%2;0tkC5XHzlZKek!`R9f3?{6PY*v5hf6B=v;MG^8A4 +pie chart illusion of a pyramid +

Sun arise each and every morning

+ + +Or you can use standard markdown for static figures with the following syntax: + +`![optional caption that appears below the figure](figure url){alt='alt text for +accessibility purposes'}` + +![You belong in The Carpentries!](https://raw.githubusercontent.com/carpentries/logo/master/Badge_Carpentries.svg){alt='Blue Carpentries hex person logo with no text.'} + +::::::::::::::::::::::::::::::::::::: callout + +Callout sections can highlight information. + +They are sometimes used to emphasise particularly important points +but are also used in some lessons to present "asides": +content that is not central to the narrative of the lesson, +e.g. by providing the answer to a commonly-asked question. + +:::::::::::::::::::::::::::::::::::::::::::::::: + + +## Math + +One of our episodes contains $\LaTeX$ equations when describing how to create +dynamic reports with {knitr}, so we now use mathjax to describe this: + +`$\alpha = \dfrac{1}{(1 - \beta)^2}$` becomes: $\alpha = \dfrac{1}{(1 - \beta)^2}$ + +Cool, right? + +::::::::::::::::::::::::::::::::::::: keypoints + +- Use `.md` files for episodes when you want static content +- Use `.Rmd` files for episodes when you need to generate output +- Run `sandpaper::check_lesson()` to identify any issues with your lesson +- Run `sandpaper::build_lesson()` to preview your lesson locally + +:::::::::::::::::::::::::::::::::::::::::::::::: + +[r-markdown]: https://rmarkdown.rstudio.com/ diff --git a/learner-profiles.md b/learner-profiles.md new file mode 100644 index 00000000..434e335a --- /dev/null +++ b/learner-profiles.md @@ -0,0 +1,5 @@ +--- +title: FIXME +--- + +This is a placeholder file. Please add content here. diff --git a/links.md b/links.md new file mode 100644 index 00000000..4c5cd2f9 --- /dev/null +++ b/links.md @@ -0,0 +1,10 @@ + + +[pandoc]: https://pandoc.org/MANUAL.html +[r-markdown]: https://rmarkdown.rstudio.com/ +[rstudio]: https://www.rstudio.com/ +[carpentries-workbench]: https://carpentries.github.io/sandpaper-docs/ + diff --git a/md5sum.txt b/md5sum.txt new file mode 100644 index 00000000..49422ba8 --- /dev/null +++ b/md5sum.txt @@ -0,0 +1,12 @@ +"file" "checksum" "built" "date" +"CODE_OF_CONDUCT.md" "c93c83c630db2fe2462240bf72552548" "site/built/CODE_OF_CONDUCT.md" "2024-02-27" +"LICENSE.md" "b24ebbb41b14ca25cf6b8216dda83e5f" "site/built/LICENSE.md" "2024-02-27" +"config.yaml" "3e7855c6ceaa6f7d37cadf15ef27e95d" "site/built/config.yaml" "2024-02-27" +"index.md" "a02c9c785ed98ddd84fe3d34ddb12fcd" "site/built/index.md" "2024-02-27" +"links.md" "8184cf4149eafbf03ce8da8ff0778c14" "site/built/links.md" "2024-02-27" +"episodes/introduction.Rmd" "6370d5592eae179125841d442e98df54" "site/built/introduction.md" "2024-02-27" +"instructors/instructor-notes.md" "cae72b6712578d74a49fea7513099f8c" "site/built/instructor-notes.md" "2024-02-27" +"learners/reference.md" "1c7cc4e229304d9806a13f69ca1b8ba4" "site/built/reference.md" "2024-02-27" +"learners/setup.md" "5456593e4a75491955ac4a252c05fbc9" "site/built/setup.md" "2024-02-27" +"profiles/learner-profiles.md" "60b93493cf1da06dfd63255d73854461" "site/built/learner-profiles.md" "2024-02-27" +"renv/profiles/lesson-requirements/renv.lock" "48006928d2eb682911e69179e0a2e496" "site/built/renv.lock" "2024-02-27" diff --git a/reference.md b/reference.md new file mode 100644 index 00000000..ba26b9fe --- /dev/null +++ b/reference.md @@ -0,0 +1,8 @@ +--- +title: 'Reference' +--- + +## Glossary + +This is a placeholder file. Please add content here. + diff --git a/renv.lock b/renv.lock new file mode 100644 index 00000000..f341574d --- /dev/null +++ b/renv.lock @@ -0,0 +1,407 @@ +{ + "R": { + "Version": "4.3.2", + "Repositories": [ + { + "Name": "carpentries", + "URL": "https://carpentries.r-universe.dev" + }, + { + "Name": "carpentries_archive", + "URL": "https://carpentries.github.io/drat" + }, + { + "Name": "CRAN", + "URL": "https://cran.rstudio.com" + } + ] + }, + "Packages": { + "R6": { + "Package": "R6", + "Version": "2.5.1", + "Source": "Repository", + "Repository": "RSPM", + "Requirements": [ + "R" + ], + "Hash": "470851b6d5d0ac559e9d01bb352b4021" + }, + "base64enc": { + "Package": "base64enc", + "Version": "0.1-3", + "Source": "Repository", + "Repository": "RSPM", + "Requirements": [ + "R" + ], + "Hash": "543776ae6848fde2f48ff3816d0628bc" + }, + "bslib": { + "Package": "bslib", + "Version": "0.6.1", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R", + "base64enc", + "cachem", + "grDevices", + "htmltools", + "jquerylib", + "jsonlite", + "lifecycle", + "memoise", + "mime", + "rlang", + "sass" + ], + "Hash": "c0d8599494bc7fb408cd206bbdd9cab0" + }, + "cachem": { + "Package": "cachem", + "Version": "1.0.8", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "fastmap", + "rlang" + ], + "Hash": "c35768291560ce302c0a6589f92e837d" + }, + "cli": { + "Package": "cli", + "Version": "3.6.1", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R", + "utils" + ], + "Hash": "89e6d8219950eac806ae0c489052048a" + }, + "digest": { + "Package": "digest", + "Version": "0.6.33", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R", + "utils" + ], + "Hash": "b18a9cf3c003977b0cc49d5e76ebe48d" + }, + "ellipsis": { + "Package": "ellipsis", + "Version": "0.3.2", + "Source": "Repository", + "Repository": "RSPM", + "Requirements": [ + "R", + "rlang" + ], + "Hash": "bb0eec2fe32e88d9e2836c2f73ea2077" + }, + "evaluate": { + "Package": "evaluate", + "Version": "0.23", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R", + "methods" + ], + "Hash": "daf4a1246be12c1fa8c7705a0935c1a0" + }, + "fastmap": { + "Package": "fastmap", + "Version": "1.1.1", + "Source": "Repository", + "Repository": "CRAN", + "Hash": "f7736a18de97dea803bde0a2daaafb27" + }, + "fontawesome": { + "Package": "fontawesome", + "Version": "0.5.2", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R", + "htmltools", + "rlang" + ], + "Hash": "c2efdd5f0bcd1ea861c2d4e2a883a67d" + }, + "fs": { + "Package": "fs", + "Version": "1.6.3", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R", + "methods" + ], + "Hash": "47b5f30c720c23999b913a1a635cf0bb" + }, + "glue": { + "Package": "glue", + "Version": "1.6.2", + "Source": "Repository", + "Repository": "RSPM", + "Requirements": [ + "R", + "methods" + ], + "Hash": "4f2596dfb05dac67b9dc558e5c6fba2e" + }, + "highr": { + "Package": "highr", + "Version": "0.10", + "Source": "Repository", + "Repository": "RSPM", + "Requirements": [ + "R", + "xfun" + ], + "Hash": "06230136b2d2b9ba5805e1963fa6e890" + }, + "htmltools": { + "Package": "htmltools", + "Version": "0.5.7", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R", + "base64enc", + "digest", + "ellipsis", + "fastmap", + "grDevices", + "rlang", + "utils" + ], + "Hash": "2d7b3857980e0e0d0a1fd6f11928ab0f" + }, + "jquerylib": { + "Package": "jquerylib", + "Version": "0.1.4", + "Source": "Repository", + "Repository": "RSPM", + "Requirements": [ + "htmltools" + ], + "Hash": "5aab57a3bd297eee1c1d862735972182" + }, + "jsonlite": { + "Package": "jsonlite", + "Version": "1.8.8", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "methods" + ], + "Hash": "e1b9c55281c5adc4dd113652d9e26768" + }, + "knitr": { + "Package": "knitr", + "Version": "1.45", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R", + "evaluate", + "highr", + "methods", + "tools", + "xfun", + "yaml" + ], + "Hash": "1ec462871063897135c1bcbe0fc8f07d" + }, + "lifecycle": { + "Package": "lifecycle", + "Version": "1.0.4", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R", + "cli", + "glue", + "rlang" + ], + "Hash": "b8552d117e1b808b09a832f589b79035" + }, + "magrittr": { + "Package": "magrittr", + "Version": "2.0.3", + "Source": "Repository", + "Repository": "RSPM", + "Requirements": [ + "R" + ], + "Hash": "7ce2733a9826b3aeb1775d56fd305472" + }, + "memoise": { + "Package": "memoise", + "Version": "2.0.1", + "Source": "Repository", + "Repository": "RSPM", + "Requirements": [ + "cachem", + "rlang" + ], + "Hash": "e2817ccf4a065c5d9d7f2cfbe7c1d78c" + }, + "mime": { + "Package": "mime", + "Version": "0.12", + "Source": "Repository", + "Repository": "RSPM", + "Requirements": [ + "tools" + ], + "Hash": "18e9c28c1d3ca1560ce30658b22ce104" + }, + "rappdirs": { + "Package": "rappdirs", + "Version": "0.3.3", + "Source": "Repository", + "Repository": "RSPM", + "Requirements": [ + "R" + ], + "Hash": "5e3c5dc0b071b21fa128676560dbe94d" + }, + "renv": { + "Package": "renv", + "Version": "1.0.3", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "utils" + ], + "Hash": "41b847654f567341725473431dd0d5ab" + }, + "rlang": { + "Package": "rlang", + "Version": "1.1.2", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R", + "utils" + ], + "Hash": "50a6dbdc522936ca35afc5e2082ea91b" + }, + "rmarkdown": { + "Package": "rmarkdown", + "Version": "2.25", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R", + "bslib", + "evaluate", + "fontawesome", + "htmltools", + "jquerylib", + "jsonlite", + "knitr", + "methods", + "stringr", + "tinytex", + "tools", + "utils", + "xfun", + "yaml" + ], + "Hash": "d65e35823c817f09f4de424fcdfa812a" + }, + "sass": { + "Package": "sass", + "Version": "0.4.7", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R6", + "fs", + "htmltools", + "rappdirs", + "rlang" + ], + "Hash": "6bd4d33b50ff927191ec9acbf52fd056" + }, + "stringi": { + "Package": "stringi", + "Version": "1.8.2", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R", + "stats", + "tools", + "utils" + ], + "Hash": "e68c45f81639001af5f1b15cd3599bbd" + }, + "stringr": { + "Package": "stringr", + "Version": "1.5.1", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R", + "cli", + "glue", + "lifecycle", + "magrittr", + "rlang", + "stringi", + "vctrs" + ], + "Hash": "960e2ae9e09656611e0b8214ad543207" + }, + "tinytex": { + "Package": "tinytex", + "Version": "0.49", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "xfun" + ], + "Hash": "5ac22900ae0f386e54f1c307eca7d843" + }, + "vctrs": { + "Package": "vctrs", + "Version": "0.6.5", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "R", + "cli", + "glue", + "lifecycle", + "rlang" + ], + "Hash": "c03fa420630029418f7e6da3667aac4a" + }, + "xfun": { + "Package": "xfun", + "Version": "0.41", + "Source": "Repository", + "Repository": "CRAN", + "Requirements": [ + "stats", + "tools" + ], + "Hash": "460a5e0fe46a80ef87424ad216028014" + }, + "yaml": { + "Package": "yaml", + "Version": "2.3.7", + "Source": "Repository", + "Repository": "CRAN", + "Hash": "0d0056cc5383fbc240ccd0cb584bf436" + } + } +} diff --git a/setup.md b/setup.md new file mode 100644 index 00000000..4244a314 --- /dev/null +++ b/setup.md @@ -0,0 +1,54 @@ +--- +title: Setup +--- + +FIXME: Setup instructions live in this document. Please specify the tools and +the data sets the Learner needs to have installed. + +## Data Sets + + +Download the [data zip file](https://example.com/FIXME) and unzip it to your Desktop + +## Software Setup + +::::::::::::::::::::::::::::::::::::::: discussion + +### Details + +Setup for different systems can be presented in dropdown menus via a `spoiler` +tag. They will join to this discussion block, so you can give a general overview +of the software used in this lesson here and fill out the individual operating +systems (and potentially add more, e.g. online setup) in the solutions blocks. + +::::::::::::::::::::::::::::::::::::::::::::::::::: + +:::::::::::::::: spoiler + +### Windows + +Use PuTTY + +:::::::::::::::::::::::: + +:::::::::::::::: spoiler + +### MacOS + +Use Terminal.app + +:::::::::::::::::::::::: + + +:::::::::::::::: spoiler + +### Linux + +Use Terminal + +:::::::::::::::::::::::: +