{{{ navbar }}} {{{ content }}} <\/div> {{{ footer }}} {{! the end of div class container is in footer }} <\/body> <\/html>
{{#site}}{{&title}}{{/site}}{{#pagetitle}}: {{&pagetitle}}{{/pagetitle}}<\/title> <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"> <script src=\"{{#site}}{{root}}{{/site}}assets/themetoggle.js\"><\/script> <link rel=\"stylesheet\" type=\"text/css\" href=\"{{#site}}{{root}}{{/site}}assets/styles.css\"> <script src=\"{{#site}}{{root}}{{/site}}assets/scripts.js\" type=\"text/javascript\"><\/script> <!-- mathjax --> <script type=\"text/x-mathjax-config\"> MathJax.Hub.Config({ config: [\"MMLorHTML.js\"], jax: [\"input/TeX\",\"input/MathML\",\"output/HTML-CSS\",\"output/NativeMML\", \"output/PreviewHTML\"], extensions: [\"tex2jax.js\",\"mml2jax.js\",\"MathMenu.js\",\"MathZoom.js\", \"fast-preview.js\", \"AssistiveMML.js\", \"a11y/accessibility-menu.js\"], TeX: { extensions: [\"AMSmath.js\",\"AMSsymbols.js\",\"noErrors.js\",\"noUndefined.js\"] }, tex2jax: { inlineMath: [['\\\\(', '\\\\)']], displayMath: [ ['$$','$$'], ['\\\\[', '\\\\]'] ], processEscapes: true } }); <\/script> <script src=\"https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js\" integrity=\"sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=\" crossorigin=\"anonymous\"><\/script> <!-- Responsive Favicon for The Carpentries --> <link rel=\"apple-touch-icon\" sizes=\"180x180\" href=\"{{#site}}{{root}}{{/site}}apple-touch-icon.png\"> <link rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"{{#site}}{{root}}{{/site}}favicon-32x32.png\"> <link rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"{{#site}}{{root}}{{/site}}favicon-16x16.png\"> <link rel=\"manifest\" href=\"{{#site}}{{root}}{{/site}}site.webmanifest\"> <link rel=\"mask-icon\" href=\"{{#site}}{{root}}{{/site}}safari-pinned-tab.svg\" color=\"#5bbad5\"> <meta name=\"msapplication-TileColor\" content=\"#da532c\"> <meta name=\"theme-color\" media=\"(prefers-color-scheme: light)\" content=\"white\" /> <meta name=\"theme-color\" media=\"(prefers-color-scheme: dark)\" content=\"black\" />"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"storage-function-factories","dir":"Articles","previous_headings":"","what":"Storage Function Factories","title":"Data and Flow from Source to Website","text":"two types storage function factories {sandpaper}: Lesson Store (.lesson_store()) List Store (.list_store()). return lists functions access calling environments, created package loaded:","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"list-store","dir":"Articles","previous_headings":"Storage Function Factories","what":"List Store","title":"Data and Flow from Source to Website","text":"list store acts like persistent list get() set(), clear(), copy() update() methods.","code":"snd <- asNamespace(\"sandpaper\") this_list <- snd$.list_store() names(this_list) ## [1] \"get\" \"update\" \"set\" \"clear\" \"copy\" class(this_list) ## [1] \"list-store\" # to set a list, use a NULL key this_list$set(key = NULL, list( A = list(first = 1), B = list( C = list( D = letters[1:4], E = sqrt(2), F = TRUE ), G = head(sleep) ) )) # get the list this_list$get() ## $A ## $A$first ## [1] 1 ## ## ## $B ## $B$C ## $B$C$D ## [1] \"a\" \"b\" \"c\" \"d\" ## ## $B$C$E ## [1] 1.414214 ## ## $B$C$F ## [1] TRUE ## ## ## $B$G ## extra group ID ## 1 0.7 1 1 ## 2 -1.6 1 2 ## 3 -0.2 1 3 ## 4 -1.2 1 4 ## 5 -0.1 1 5 ## 6 3.4 1 6 # copy a list so that you can preserve the original list that_list <- this_list$copy() # update list elements by adding to them (note: vectors will be replaced) that_list$update(list(A = list(platform = \"MY COMPUTER\"))) that_list$get() ## $A ## $A$first ## [1] 1 ## ## $A$platform ## [1] \"MY COMPUTER\" ## ## ## $B ## $B$C ## $B$C$D ## [1] \"a\" \"b\" \"c\" \"d\" ## ## $B$C$E ## [1] 1.414214 ## ## $B$C$F ## [1] TRUE ## ## ## $B$G ## extra group ID ## 1 0.7 1 1 ## 2 -1.6 1 2 ## 3 -0.2 1 3 ## 4 -1.2 1 4 ## 5 -0.1 1 5 ## 6 3.4 1 6 # set nested list elements that_list$set(c(\"A\", \"platform\"), \"YOUR COMPUTER\") # note that modified copies do not modify the originals that_list$get()[[\"A\"]] ## $first ## [1] 1 ## ## $platform ## [1] \"YOUR COMPUTER\" this_list$get()[[\"A\"]] ## $first ## [1] 1"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"lesson-store","dir":"Articles","previous_headings":"Storage Function Factories","what":"Lesson Store","title":"Data and Flow from Source to Website","text":"creates object containing pegboard::Lesson object, can use extract episode-specific metadata along text questions. special object lesson set object, additionally set global data. {sandpaper} loaded, List Store Lesson Store objects created live {sandpaper} namespace long session active.","code":"snd <- asNamespace(\"sandpaper\") some_lesson <- snd$.lesson_store() names(some_lesson) ## [1] \"get\" \"valid\" \"set\" \"clear\""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"example","dir":"Articles","previous_headings":"","what":"Example","title":"Data and Flow from Source to Website","text":"metadata collected stored memory lesson built (triggered validate_lesson()), accessible via objects defined internal sandpaper:::set_globals(). set example lesson use demonstrate global variables. Please note using internal functions demonstration. internal functions guaranteed stable outside context {sandpaper}. Using asNamespace(\"sandpaper\") function allows create method accessing internal functions: Within {sandpaper}, environments contain metadata related whole lesson called .store, .resources, instructor_globals, learner_globals, this_metadata. lesson validated, values empty: contain following information: .store pegboard::Lesson object contains XML representation parsed Markdown source files this_metadata real computed metadata associated lesson along JSON-LD template generating metadata footer lesson. .resources list availabe files used build lesson order specified config.yaml instructor_globals pre-computed global data includes sidebar template, syllabus, dropdown menus, information packages used build lesson learner_globals instructor_globals, specifically learner view run validate_lesson() first time, metadata collected parsed config.yaml, individual episodes cached. validate_lesson() call pull cache .store exists valid (means nothing git changed). ’s valid exist, global storage initialised general cascade: Now variables called, can see information stored .","code":"library(\"sandpaper\") snd <- asNamespace(\"sandpaper\") # create a new lesson lsn <- create_lesson(tempfile(), name = \"An Example Lesson\", rstudio = TRUE, open = FALSE, rmd = FALSE) # add a new episode create_episode_md(title = \"First Example\", add = TRUE, path = lsn, open = FALSE) ## /tmp/RtmpBGmQ1z/file2b1810e20a91/episodes/first-example.md snd <- asNamespace(\"sandpaper\") class(snd$.store) ## [1] \"list\" print(snd$.store$get()) ## NULL class(snd$this_metadata) ## [1] \"list-store\" snd$this_metadata$get() ## list() class(snd$.resources) ## [1] \"list-store\" snd$.resources$get() ## list() class(snd$instructor_globals) ## [1] \"list-store\" snd$instructor_globals$get() ## list() class(snd$learner_globals) ## [1] \"list-store\" snd$learner_globals$get() ## list() # first run is always longer than the second system.time(validate_lesson(lsn)) ## ── Validating Fenced Divs ────────────────────────────────────────────── ## ── Validating Internal Links and Images ──────────────────────────────── ## user system elapsed ## 0.335 0.028 0.363 system.time(validate_lesson(lsn)) ## ── Validating Fenced Divs ────────────────────────────────────────────── ## ── Validating Internal Links and Images ──────────────────────────────── ## user system elapsed ## 0.108 0.000 0.107 ## validate_lesson() ## └─this_lesson() ## ├─.store$valid() ## │ ├─gert::git_diff() ## │ ├─gert::git_status() ## │ └─gert::git_log() ## ├─pegboard::Lesson$new() ## └─.store$set() ## └─set_globals() ## ├─initialise_metadata() ## │ ├─get_config() ## │ ├─template_metadata() ## │ └─this_metadata$set() ## ├─set_language() ## │ └─add_varnish_translations() ## │ └─tr_() ## │ └─these$translations ## ├─set_resource_list() ## │ ├─get_resource_list() ## │ │ └─get_config() ## │ └─.resources$set() ## ├─create_sidebar() ## ├─create_resources_dropdown() ## ├─learner_globals$set() ## └─instructor_globals$set()"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"lesson-storage","dir":"Articles","previous_headings":"","what":"Lesson Storage","title":"Data and Flow from Source to Website","text":"function stores pegboard::Lesson object responsible initialising resetting variable cache. can check cache needs reset using $valid() function inside object, checks git log, git status, git diff global check lesson contents. nothing changes, returns TRUE: However, update lesson contents way setting config variable, FALSE, indicating needs reset:","code":"snd <- asNamespace(\"sandpaper\") class(snd$.store) ## [1] \"list\" print(snd$.store$get()) ## <Lesson> ## Public: ## blocks: function (type = NULL, level = 0, path = FALSE) ## built: NULL ## challenges: function (path = FALSE, graph = FALSE, recurse = TRUE) ## children: NULL ## clone: function (deep = FALSE) ## episodes: list ## extra: list ## files: active binding ## get: function (element = NULL, collection = \"episodes\") ## handout: function (path = NULL, solution = FALSE) ## has_children: active binding ## initialize: function (path = \".\", rmd = FALSE, jekyll = TRUE, ...) ## isolate_blocks: function () ## load_built: function () ## n_problems: active binding ## overview: FALSE ## path: /tmp/RtmpBGmQ1z/file2b1810e20a91 ## reset: function () ## rmd: FALSE ## sandpaper: TRUE ## show_problems: active binding ## solutions: function (path = FALSE) ## summary: function (collection = \"episodes\") ## thin: function (verbose = TRUE) ## trace_lineage: function (episode_path) ## validate_divs: function () ## validate_headings: function (verbose = TRUE) ## validate_links: function () ## Private: ## deep_clone: function (name, value) snd$.store$valid(lsn) ## [1] TRUE set_config(c(handout = TRUE), path = lsn, write = TRUE, create = TRUE) ## ℹ Writing to /tmp/RtmpBGmQ1z/file2b1810e20a91/config.yaml ## → NA -> handout: true snd$.store$valid(lsn) ## [1] FALSE snd$.store$set(lsn) snd$.store$valid(lsn) ## [1] TRUE"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"metadata","dir":"Articles","previous_headings":"","what":"Metadata","title":"Data and Flow from Source to Website","text":"metadata used store content config.yaml provide computed metadata lesson included footer JSON-LD object, useful indexing. Note metadata must duplicated page give correct URL identifiers. metadata rendered JSON-LD passed new variable {varnish} using internal fill_metadata_template() function:","code":"snd <- asNamespace(\"sandpaper\") snd$this_metadata$get() ## $carpentry ## [1] \"incubator\" ## ## $title ## [1] \"An Example Lesson\" ## ## $created ## [1] \"2024-10-15\" ## ## $keywords ## [1] \"software, data, lesson, The Carpentries\" ## ## $life_cycle ## [1] \"pre-alpha\" ## ## $license ## [1] \"CC-BY 4.0\" ## ## $source ## [1] \"https://github.com/carpentries/file2b1810e20a91\" ## ## $branch ## [1] \"main\" ## ## $contact ## [1] \"team@carpentries.org\" ## ## $episodes ## [1] \"introduction.md\" \"first-example.md\" ## ## $metadata_template ## [1] \"{{=<% %>=}}\" ## [2] \"{\" ## [3] \" \\\"@context\\\": \\\"https://schema.org\\\",\" ## [4] \" \\\"@type\\\": \\\"TrainingMaterial\\\",\" ## [5] \" \\\"@id\\\": \\\"<% url %>\\\",\" ## [6] \" \\\"inLanguage\\\": \\\"<% lang %>\\\",\" ## [7] \" \\\"dct:conformsTo\\\": \\\"https://bioschemas.org/profiles/TrainingMaterial/1.0-RELEASE\\\",\" ## [8] \" \\\"description\\\": \\\"<% desc %><% ^desc %>A Carpentries Lesson teaching foundational data and coding skills to researchers worldwide<% /desc %>\\\",\" ## [9] \" \\\"keywords\\\": \\\"<% keywords %><% ^keywords %>software,data,lesson,The Carpentries<% /keywords %>\\\",\" ## [10] \" \\\"name\\\": \\\"<% &pagetitle %>\\\",\" ## [11] \" \\\"creativeWorkStatus\\\": \\\"active\\\",\" ## [12] \" \\\"url\\\": \\\"<% url %>\\\",\" ## [13] \" \\\"identifier\\\": \\\"<% url %>\\\",\" ## [14] \" <% #date %>\\\"dateCreated\\\": \\\"<% created %>\\\",\" ## [15] \" \\\"dateModified\\\": \\\"<% modified %>\\\",\" ## [16] \" \\\"datePublished\\\": \\\"<% published %>\\\"<% /date %>\" ## [17] \"}\" ## [18] \"<%={{ }}=%>\" ## ## $pagetitle ## [1] \"An Example Lesson\" ## ## $date ## $date$created ## [1] \"2024-10-15\" ## ## $date$modified ## [1] \"2024-10-15\" ## ## $date$published ## [1] \"2024-10-15\" ## ## ## $url ## [1] \"https://carpentries.github.io/file2b1810e20a91/\" ## ## $citation ## [1] \"CITATION.cff\" ## ## $overview ## [1] FALSE ## ## $handout ## [1] TRUE writeLines(snd$fill_metadata_template(snd$this_metadata)) ## { ## \"@context\": \"https://schema.org\", ## \"@type\": \"TrainingMaterial\", ## \"@id\": \"https://carpentries.github.io/file2b1810e20a91/index.html\", ## \"inLanguage\": \"en\", ## \"dct:conformsTo\": \"https://bioschemas.org/profiles/TrainingMaterial/1.0-RELEASE\", ## \"description\": \"A Carpentries Lesson teaching foundational data and coding skills to researchers worldwide\", ## \"keywords\": \"software, data, lesson, The Carpentries\", ## \"name\": \"An Example Lesson\", ## \"creativeWorkStatus\": \"active\", ## \"url\": \"https://carpentries.github.io/file2b1810e20a91/index.html\", ## \"identifier\": \"https://carpentries.github.io/file2b1810e20a91/index.html\", ## \"dateCreated\": \"2024-10-15\", ## \"dateModified\": \"2024-10-15\", ## \"datePublished\": \"2024-10-15\" ## }"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"lesson-resources-files","dir":"Articles","previous_headings":"","what":"Lesson Resources (files)","title":"Data and Flow from Source to Website","text":"next thing store globally resources use build lesson. allows us avoid needing constantly read file system:","code":"snd <- asNamespace(\"sandpaper\") snd$.resources$get() ## $. ## /tmp/RtmpBGmQ1z/file2b1810e20a91/CODE_OF_CONDUCT.md ## \"/tmp/RtmpBGmQ1z/file2b1810e20a91/CODE_OF_CONDUCT.md\" ## /tmp/RtmpBGmQ1z/file2b1810e20a91/LICENSE.md ## \"/tmp/RtmpBGmQ1z/file2b1810e20a91/LICENSE.md\" ## /tmp/RtmpBGmQ1z/file2b1810e20a91/config.yaml ## \"/tmp/RtmpBGmQ1z/file2b1810e20a91/config.yaml\" ## /tmp/RtmpBGmQ1z/file2b1810e20a91/index.md ## \"/tmp/RtmpBGmQ1z/file2b1810e20a91/index.md\" ## /tmp/RtmpBGmQ1z/file2b1810e20a91/links.md ## \"/tmp/RtmpBGmQ1z/file2b1810e20a91/links.md\" ## ## $episodes ## /tmp/RtmpBGmQ1z/file2b1810e20a91/episodes/introduction.md ## \"/tmp/RtmpBGmQ1z/file2b1810e20a91/episodes/introduction.md\" ## /tmp/RtmpBGmQ1z/file2b1810e20a91/episodes/first-example.md ## \"/tmp/RtmpBGmQ1z/file2b1810e20a91/episodes/first-example.md\" ## ## $instructors ## /tmp/RtmpBGmQ1z/file2b1810e20a91/instructors/instructor-notes.md ## \"/tmp/RtmpBGmQ1z/file2b1810e20a91/instructors/instructor-notes.md\" ## ## $learners ## /tmp/RtmpBGmQ1z/file2b1810e20a91/learners/reference.md ## \"/tmp/RtmpBGmQ1z/file2b1810e20a91/learners/reference.md\" ## /tmp/RtmpBGmQ1z/file2b1810e20a91/learners/setup.md ## \"/tmp/RtmpBGmQ1z/file2b1810e20a91/learners/setup.md\" ## ## $profiles ## /tmp/RtmpBGmQ1z/file2b1810e20a91/profiles/learner-profiles.md ## \"/tmp/RtmpBGmQ1z/file2b1810e20a91/profiles/learner-profiles.md\" ## ## $`renv/profiles/lesson-requirements` ## ## \"/tmp/RtmpBGmQ1z/file2b1810e20a91/renv/profiles/lesson-requirements/renv.lock\""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"global-and-local-variables","dir":"Articles","previous_headings":"","what":"Global and Local Variables","title":"Data and Flow from Source to Website","text":"rest global local variables recorded instructor_globals learner_globals. copied page updated local data (e.g. sidebar needs include headings current page).","code":"snd <- asNamespace(\"sandpaper\") snd$instructor_globals$get() ## $aio ## [1] TRUE ## ## $instructor ## [1] TRUE ## ## $sidebar ## [1] \"<div class=\\\"accordion accordion-flush\\\" id=\\\"accordionFlush1\\\">\\n <div class=\\\"accordion-item\\\">\\n <div class=\\\"accordion-header\\\" id=\\\"flush-heading1\\\">\\n <a href=\\\"index.html\\\">Summary and Schedule<\/a>\\n <\/div><!--/div.accordion-header-->\\n \\n <\/div><!--/div.accordion-item-->\\n<\/div><!--/div.accordion-flush-->\\n\" ## [2] \"<div class=\\\"accordion accordion-flush\\\" id=\\\"accordionFlush2\\\">\\n <div class=\\\"accordion-item\\\">\\n <div class=\\\"accordion-header\\\" id=\\\"flush-heading2\\\">\\n <a href='introduction.html'>1. introduction<\/a>\\n <\/div><!--/div.accordion-header-->\\n \\n <\/div><!--/div.accordion-item-->\\n<\/div><!--/div.accordion-flush-->\\n\" ## [3] \"<div class=\\\"accordion accordion-flush\\\" id=\\\"accordionFlush3\\\">\\n <div class=\\\"accordion-item\\\">\\n <div class=\\\"accordion-header\\\" id=\\\"flush-heading3\\\">\\n <a href='first-example.html'>2. First Example<\/a>\\n <\/div><!--/div.accordion-header-->\\n \\n <\/div><!--/div.accordion-item-->\\n<\/div><!--/div.accordion-flush-->\\n\" ## ## $more ## [1] \"<hr><li><a class='dropdown-item' href='reference.html'>Reference<\/a><\/li>\" ## ## $resources ## [1] \"<hr><li><a class='dropdown-item' href='reference.html'>Reference<\/a><\/li>\" ## ## $translate ## $translate$SkipToMain ## [1] \"Skip to main content\" ## ## $translate$iPreAlpha ## [1] \"Pre-Alpha\" ## ## $translate$PreAlphaNote ## [1] \"This lesson is in the pre-alpha phase, which means that it is in early development, but has not yet been taught.\" ## ## $translate$AlphaNote ## [1] \"This lesson is in the alpha phase, which means that it has been taught once and lesson authors are iterating on feedback.\" ## ## $translate$iAlpha ## [1] \"Alpha\" ## ## $translate$BetaNote ## [1] \"This lesson is in the beta phase, which means that it is ready for teaching by instructors outside of the original author team.\" ## ## $translate$iBeta ## [1] \"Beta\" ## ## $translate$PeerReview ## [1] \"This lesson has passed peer review.\" ## ## $translate$InstructorView ## [1] \"Instructor View\" ## ## $translate$LearnerView ## [1] \"Learner View\" ## ## $translate$MainNavigation ## [1] \"Main Navigation\" ## ## $translate$ToggleNavigation ## [1] \"Toggle Navigation\" ## ## $translate$ToggleDarkMode ## [1] \"Toggle theme (auto)\" ## ## $translate$Menu ## [1] \"Menu\" ## ## $translate$SearchButton ## [1] \"Search the All In One page\" ## ## $translate$Setup ## [1] \"Setup\" ## ## $translate$KeyPoints ## [1] \"Key Points\" ## ## $translate$InstructorNotes ## [1] \"Instructor Notes\" ## ## $translate$Glossary ## [1] \"Glossary\" ## ## $translate$LearnerProfiles ## [1] \"Learner Profiles\" ## ## $translate$More ## [1] \"More\" ## ## $translate$LessonProgress ## [1] \"Lesson Progress\" ## ## $translate$CloseMenu ## [1] \"close menu\" ## ## $translate$EPISODES ## [1] \"EPISODES\" ## ## $translate$Home ## [1] \"Home\" ## ## $translate$HomePageNav ## [1] \"Home Page Navigation\" ## ## $translate$RESOURCES ## [1] \"RESOURCES\" ## ## $translate$ExtractAllImages ## [1] \"Extract All Images\" ## ## $translate$AIO ## [1] \"See all in one page\" ## ## $translate$DownloadHandout ## [1] \"Download Lesson Handout\" ## ## $translate$ExportSlides ## [1] \"Export Chapter Slides\" ## ## $translate$PreviousAndNext ## [1] \"Previous and Next Chapter\" ## ## $translate$Previous ## [1] \"Previous\" ## ## $translate$EstimatedTime ## [1] \"Estimated time: {icons$clock} {minutes} minutes\" ## ## $translate$Next ## [1] \"Next\" ## ## $translate$NextChapter ## [1] \"Next Chapter\" ## ## $translate$LastUpdate ## [1] \"Last updated on {updated}\" ## ## $translate$EditThisPage ## [1] \"Edit this page\" ## ## $translate$ExpandAllSolutions ## [1] \"Expand All Solutions\" ## ## $translate$SetupInstructions ## [1] \"Setup Instructions\" ## ## $translate$DownloadFiles ## [1] \"Download files required for the lesson\" ## ## $translate$ActualScheduleNote ## [1] \"The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.\" ## ## $translate$BackToTop ## [1] \"Back To Top\" ## ## $translate$SpanToTop ## [1] \"<(Back)> To Top\" ## ## $translate$ThisLessonCoC ## [1] \"This lesson is subject to the <(Code of Conduct)>\" ## ## $translate$CoC ## [1] \"Code of Conduct\" ## ## $translate$EditOnGH ## [1] \"Edit on GitHub\" ## ## $translate$Contributing ## [1] \"Contributing\" ## ## $translate$Source ## [1] \"Source\" ## ## $translate$Cite ## [1] \"Cite\" ## ## $translate$Contact ## [1] \"Contact\" ## ## $translate$About ## [1] \"About\" ## ## $translate$MaterialsLicensedUnder ## [1] \"Materials licensed under {license} by the authors\" ## ## $translate$TemplateLicense ## [1] \"Template licensed under <(CC-BY 4.0)> by {template_authors}\" ## ## $translate$Carpentries ## [1] \"The Carpentries\" ## ## $translate$BuiltWith ## [1] \"Built with {sandpaper_link}, {pegboard_link}, and {varnish_link}\" ## ## $translate$ExpandAllSolutions ## [1] \"Expand All Solutions\" ## ## $translate$CollapseAllSolutions ## [1] \"Collapse All Solutions\" ## ## $translate$Collapse ## [1] \"Collapse\" ## ## $translate$Episodes ## [1] \"Episodes\" ## ## $translate$GiveFeedback ## [1] \"Give Feedback\" ## ## $translate$LearnMore ## [1] \"Learn More\" ## ## ## $sandpaper_version ## (0.16.9.9000) ## ## $sandpaper_cfg ## NULL ## ## $pegboard_version ## (0.7.6) ## ## $pegboard_cfg ## [1] \"carpentries/pegboard/tree/ad2542f7f7b9c3f90cc871b355ff81ec14a09ca9\" ## ## $varnish_version ## (1.0.4) ## ## $varnish_cfg ## [1] \"carpentries/varnish/tree/0f0552ea659b29cd034e5ac5ebb84aacaa302051\" ## ## $sandpaper_link ## <a href=\"https://github.com/carpentries/sandpaper\">sandpaper (0.16.9.9000)<\/a> ## ## $pegboard_link ## <a href=\"https://github.com/carpentries/pegboard/tree/ad2542f7f7b9c3f90cc871b355ff81ec14a09ca9\">pegboard (0.7.6)<\/a> ## ## $varnish_link ## <a href=\"https://github.com/carpentries/varnish/tree/0f0552ea659b29cd034e5ac5ebb84aacaa302051\">varnish (1.0.4)<\/a> ## ## $syllabus ## episode timings path percents ## introduction.md introduction 00h 00m introduction.html 0 ## first-example.md First Example 00h 12m first-example.html 50 ## Finish 00h 24m 100 ## questions ## introduction.md How do you write a lesson using R Markdown and `{sandpaper}`? ## first-example.md How do you write a lesson using R Markdown and `{sandpaper}`? ## ## ## $overview ## [1] FALSE snd$learner_globals$get() ## $aio ## [1] TRUE ## ## $instructor ## [1] FALSE ## ## $sidebar ## [1] \"<div class=\\\"accordion accordion-flush\\\" id=\\\"accordionFlush1\\\">\\n <div class=\\\"accordion-item\\\">\\n <div class=\\\"accordion-header\\\" id=\\\"flush-heading1\\\">\\n <a href=\\\"index.html\\\">Summary and Setup<\/a>\\n <\/div><!--/div.accordion-header-->\\n \\n <\/div><!--/div.accordion-item-->\\n<\/div><!--/div.accordion-flush-->\\n\" ## [2] \"<div class=\\\"accordion accordion-flush\\\" id=\\\"accordionFlush2\\\">\\n <div class=\\\"accordion-item\\\">\\n <div class=\\\"accordion-header\\\" id=\\\"flush-heading2\\\">\\n <a href='introduction.html'>1. introduction<\/a>\\n <\/div><!--/div.accordion-header-->\\n \\n <\/div><!--/div.accordion-item-->\\n<\/div><!--/div.accordion-flush-->\\n\" ## [3] \"<div class=\\\"accordion accordion-flush\\\" id=\\\"accordionFlush3\\\">\\n <div class=\\\"accordion-item\\\">\\n <div class=\\\"accordion-header\\\" id=\\\"flush-heading3\\\">\\n <a href='first-example.html'>2. First Example<\/a>\\n <\/div><!--/div.accordion-header-->\\n \\n <\/div><!--/div.accordion-item-->\\n<\/div><!--/div.accordion-flush-->\\n\" ## ## $more ## [1] \"<li><a class='dropdown-item' href='reference.html'>Reference<\/a><\/li>\" ## ## $resources ## [1] \"<li><a href='reference.html'>Reference<\/a><\/li>\" ## ## $translate ## $translate$SkipToMain ## [1] \"Skip to main content\" ## ## $translate$iPreAlpha ## [1] \"Pre-Alpha\" ## ## $translate$PreAlphaNote ## [1] \"This lesson is in the pre-alpha phase, which means that it is in early development, but has not yet been taught.\" ## ## $translate$AlphaNote ## [1] \"This lesson is in the alpha phase, which means that it has been taught once and lesson authors are iterating on feedback.\" ## ## $translate$iAlpha ## [1] \"Alpha\" ## ## $translate$BetaNote ## [1] \"This lesson is in the beta phase, which means that it is ready for teaching by instructors outside of the original author team.\" ## ## $translate$iBeta ## [1] \"Beta\" ## ## $translate$PeerReview ## [1] \"This lesson has passed peer review.\" ## ## $translate$InstructorView ## [1] \"Instructor View\" ## ## $translate$LearnerView ## [1] \"Learner View\" ## ## $translate$MainNavigation ## [1] \"Main Navigation\" ## ## $translate$ToggleNavigation ## [1] \"Toggle Navigation\" ## ## $translate$ToggleDarkMode ## [1] \"Toggle theme (auto)\" ## ## $translate$Menu ## [1] \"Menu\" ## ## $translate$SearchButton ## [1] \"Search the All In One page\" ## ## $translate$Setup ## [1] \"Setup\" ## ## $translate$KeyPoints ## [1] \"Key Points\" ## ## $translate$InstructorNotes ## [1] \"Instructor Notes\" ## ## $translate$Glossary ## [1] \"Glossary\" ## ## $translate$LearnerProfiles ## [1] \"Learner Profiles\" ## ## $translate$More ## [1] \"More\" ## ## $translate$LessonProgress ## [1] \"Lesson Progress\" ## ## $translate$CloseMenu ## [1] \"close menu\" ## ## $translate$EPISODES ## [1] \"EPISODES\" ## ## $translate$Home ## [1] \"Home\" ## ## $translate$HomePageNav ## [1] \"Home Page Navigation\" ## ## $translate$RESOURCES ## [1] \"RESOURCES\" ## ## $translate$ExtractAllImages ## [1] \"Extract All Images\" ## ## $translate$AIO ## [1] \"See all in one page\" ## ## $translate$DownloadHandout ## [1] \"Download Lesson Handout\" ## ## $translate$ExportSlides ## [1] \"Export Chapter Slides\" ## ## $translate$PreviousAndNext ## [1] \"Previous and Next Chapter\" ## ## $translate$Previous ## [1] \"Previous\" ## ## $translate$EstimatedTime ## [1] \"Estimated time: {icons$clock} {minutes} minutes\" ## ## $translate$Next ## [1] \"Next\" ## ## $translate$NextChapter ## [1] \"Next Chapter\" ## ## $translate$LastUpdate ## [1] \"Last updated on {updated}\" ## ## $translate$EditThisPage ## [1] \"Edit this page\" ## ## $translate$ExpandAllSolutions ## [1] \"Expand All Solutions\" ## ## $translate$SetupInstructions ## [1] \"Setup Instructions\" ## ## $translate$DownloadFiles ## [1] \"Download files required for the lesson\" ## ## $translate$ActualScheduleNote ## [1] \"The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.\" ## ## $translate$BackToTop ## [1] \"Back To Top\" ## ## $translate$SpanToTop ## [1] \"<(Back)> To Top\" ## ## $translate$ThisLessonCoC ## [1] \"This lesson is subject to the <(Code of Conduct)>\" ## ## $translate$CoC ## [1] \"Code of Conduct\" ## ## $translate$EditOnGH ## [1] \"Edit on GitHub\" ## ## $translate$Contributing ## [1] \"Contributing\" ## ## $translate$Source ## [1] \"Source\" ## ## $translate$Cite ## [1] \"Cite\" ## ## $translate$Contact ## [1] \"Contact\" ## ## $translate$About ## [1] \"About\" ## ## $translate$MaterialsLicensedUnder ## [1] \"Materials licensed under {license} by the authors\" ## ## $translate$TemplateLicense ## [1] \"Template licensed under <(CC-BY 4.0)> by {template_authors}\" ## ## $translate$Carpentries ## [1] \"The Carpentries\" ## ## $translate$BuiltWith ## [1] \"Built with {sandpaper_link}, {pegboard_link}, and {varnish_link}\" ## ## $translate$ExpandAllSolutions ## [1] \"Expand All Solutions\" ## ## $translate$CollapseAllSolutions ## [1] \"Collapse All Solutions\" ## ## $translate$Collapse ## [1] \"Collapse\" ## ## $translate$Episodes ## [1] \"Episodes\" ## ## $translate$GiveFeedback ## [1] \"Give Feedback\" ## ## $translate$LearnMore ## [1] \"Learn More\" ## ## ## $sandpaper_version ## (0.16.9.9000) ## ## $sandpaper_cfg ## NULL ## ## $pegboard_version ## (0.7.6) ## ## $pegboard_cfg ## [1] \"carpentries/pegboard/tree/ad2542f7f7b9c3f90cc871b355ff81ec14a09ca9\" ## ## $varnish_version ## (1.0.4) ## ## $varnish_cfg ## [1] \"carpentries/varnish/tree/0f0552ea659b29cd034e5ac5ebb84aacaa302051\" ## ## $sandpaper_link ## <a href=\"https://github.com/carpentries/sandpaper\">sandpaper (0.16.9.9000)<\/a> ## ## $pegboard_link ## <a href=\"https://github.com/carpentries/pegboard/tree/ad2542f7f7b9c3f90cc871b355ff81ec14a09ca9\">pegboard (0.7.6)<\/a> ## ## $varnish_link ## <a href=\"https://github.com/carpentries/varnish/tree/0f0552ea659b29cd034e5ac5ebb84aacaa302051\">varnish (1.0.4)<\/a> ## ## $overview ## [1] FALSE"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"translations","dir":"Articles","previous_headings":"Global and Local Variables","what":"Translations","title":"Data and Flow from Source to Website","text":"majority {varnish} templates keys need translations format {{ translate.ThingInPascalCase }}: variables {sandpaper} expected exist. expected exist, theese variables generated stored internal environment $translations function establish_translation_vars() package loaded. lesson validated, variables translated correct language set_language() placed instructor_globals learner_globals storage. variables passed directly {varnish} templates, eventually get processed {whisker}: key building lessons languages, regardless default language. lesson author sets lang: config key two-letter language code lesson written . gets passed set_language() function, modifies translations inside global data, modify language user session: Switching language controlled entirely within lesson config:","code":"<!-- START: inst/pkgdown/templates/content-syllabus.html --> <div class=\"col-xl-12 col-lg-12\"> <main id=\"main-content\" class=\"main-content\"> <h1>{{& pagetitle }}<\/h1> <div class=\"container lesson-content\"> <p> {{# translate.LastUpdate }} {{& translate.LastUpdate }} |{{/ translate.LastUpdate }} <a href=\"{{#yaml}}{{source}}/edit/{{branch}}/{{/yaml}}{{file_source}}{{^file_source}}index.md{{/file_source}}\"> {{ translate.EditThisPage }} <i aria-hidden=\"true\" data-feather=\"edit\"><\/i> <\/a> <\/p> {{& readme }} {{#syllabus}} <section id=\"schedule\"> <table class=\"table schedule table-striped\" role=\"presentation\"> <tbody> {{#setup}} <tr> <td><\/td><td><a href=\"#setup\">{{ translate.SetupInstructions }}<\/a><\/td><td> {{ translate.DownloadFiles }}<\/td> <\/tr> {{/setup}} {{& syllabus }} <\/table> <p> {{ translate.ActualScheduleNote }} <\/p> <\/section> {{/syllabus}} {{#setup}} <section id=\"setup\"> {{{setup}}} <\/section> {{/setup}} <\/main> <\/div> <!-- END : inst/pkgdown/templates/content-syllabus.html --> snd <- asNamespace(\"sandpaper\") whisker::whisker.render(\"Edit this page: {{ translate.EditThisPage }}\", data = snd$instructor_globals$get() ) ## [1] \"Edit this page: Edit this page\" snd <- asNamespace(\"sandpaper\") snd$set_config(c(lang = \"es\"), path = lsn, create = TRUE, write = TRUE) ## ℹ Writing to /tmp/RtmpBGmQ1z/file2b1810e20a91/config.yaml ## → NA -> lang: 'es' snd$this_lesson(lsn) whisker::whisker.render(\"Edit this page: {{ translate.EditThisPage }}\", data = snd$instructor_globals$get() ) ## [1] \"Edit this page: Mejora esta página\" Sys.getenv(\"LANGUAGE\") ## [1] \"en\" snd$set_config(c(lang = \"en\"), path = lsn, create = TRUE, write = TRUE) ## ℹ Writing to /tmp/RtmpBGmQ1z/file2b1810e20a91/config.yaml ## → lang: 'es' -> lang: 'en' snd$this_lesson(lsn) whisker::whisker.render(\"Edit this page: {{ translate.EditThisPage }}\", data = snd$instructor_globals$get() ) ## [1] \"Edit this page: Edit this page\""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"translation-variables","dir":"Articles","previous_headings":"Global and Local Variables","what":"Translation Variables","title":"Data and Flow from Source to Website","text":"62 translations generated set_language() correspond following variables varnish: addition, 26 translations inserted get varnish:","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"pkgdown-metadata","dir":"Articles","previous_headings":"","what":"pkgdown metadata","title":"Data and Flow from Source to Website","text":"Another source metadata created pkgdown file called site/_pkgdown.yaml. file allows {pkgdown} recognise website needs built. variables compiled pkg variable passed downstream files build_site(). important elements use $lang stores language variable $src_path stores source path lesson (site/ directory, location SANDPAPER_SITE environment variable). $dst_path stores destination path lesson (site/docs). NOTE: particular path changed build_site() update name path ’s less confusing. docs folder mechanism pkgdown locally deploy site without affect package structure (also mechanism serve GitHub pages past). $meta list items passed {varnish} sent rendered, goes one transformation, variable contexts find {varnish} come . contexts use site root path title, yaml lesson-wide content, lang define language. Everything else used.","code":"# ------------------------------------------------------------------ information # This file was generated by sandpaper version '0.16.9.9000' # If you want to make changes, please edit '/tmp/RtmpBGmQ1z/file2b1810e20a91/config.yaml' # ------------------------------------------------------------------ information title: An Example Lesson lang: en home: title: Home strip_header: yes description: ~ template: package: varnish params: time: 2024-10-15 13:31:10 +0000 source: https://github.com/carpentries/file2b1810e20a91 branch: main contact: team@carpentries.org license: CC-BY 4.0 handout: ~ cp: no lc: no dc: no swc: no carpentry: incubator carpentry_name: Carpentries Incubator carpentry_icon: incubator life_cycle: pre-alpha pre_alpha: yes alpha: no beta: no stable: no doi: ~ title: An Example Lesson created: '2024-10-15' keywords: software, data, lesson, The Carpentries episodes: ~ learners: ~ instructors: ~ profiles: ~ snd <- asNamespace(\"sandpaper\") pkg <- pkgdown::as_pkgdown(snd$path_site(lsn)) pkg[c(\"lang\", \"src_path\", \"dst_path\", \"meta\")] ## $lang ## [1] \"en\" ## ## $src_path ## /tmp/RtmpBGmQ1z/file2b1810e20a91/site ## ## $dst_path ## /tmp/RtmpBGmQ1z/file2b1810e20a91/site/docs ## ## $meta ## $meta$title ## [1] \"An Example Lesson\" ## ## $meta$lang ## [1] \"en\" ## ## $meta$home ## $meta$home$title ## [1] \"Home\" ## ## $meta$home$strip_header ## [1] TRUE ## ## $meta$home$description ## NULL ## ## ## $meta$template ## $meta$template$package ## [1] \"varnish\" ## ## $meta$template$params ## $meta$template$params$time ## [1] \"2024-10-15 13:31:10 +0000\" ## ## $meta$template$params$source ## [1] \"https://github.com/carpentries/file2b1810e20a91\" ## ## $meta$template$params$branch ## [1] \"main\" ## ## $meta$template$params$contact ## [1] \"team@carpentries.org\" ## ## $meta$template$params$license ## [1] \"CC-BY 4.0\" ## ## $meta$template$params$handout ## NULL ## ## $meta$template$params$cp ## [1] FALSE ## ## $meta$template$params$lc ## [1] FALSE ## ## $meta$template$params$dc ## [1] FALSE ## ## $meta$template$params$swc ## [1] FALSE ## ## $meta$template$params$carpentry ## [1] \"incubator\" ## ## $meta$template$params$carpentry_name ## [1] \"Carpentries Incubator\" ## ## $meta$template$params$carpentry_icon ## [1] \"incubator\" ## ## $meta$template$params$life_cycle ## [1] \"pre-alpha\" ## ## $meta$template$params$pre_alpha ## [1] TRUE ## ## $meta$template$params$alpha ## [1] FALSE ## ## $meta$template$params$beta ## [1] FALSE ## ## $meta$template$params$stable ## [1] FALSE ## ## $meta$template$params$doi ## NULL ## ## $meta$template$params$title ## [1] \"An Example Lesson\" ## ## $meta$template$params$created ## [1] \"2024-10-15\" ## ## $meta$template$params$keywords ## [1] \"software, data, lesson, The Carpentries\" ## ## $meta$template$params$episodes ## NULL ## ## $meta$template$params$learners ## NULL ## ## $meta$template$params$instructors ## NULL ## ## $meta$template$params$profiles ## NULL dat <- pkgdown::data_template(pkg) writeLines(yaml::as.yaml(dat[c(\"lang\", \"site\", \"yaml\")])) ## lang: en ## site: ## root: '' ## title: An Example Lesson ## yaml: ## time: 2024-10-15 13:31:10 +0000 ## source: https://github.com/carpentries/file2b1810e20a91 ## branch: main ## contact: team@carpentries.org ## license: CC-BY 4.0 ## handout: ~ ## cp: no ## lc: no ## dc: no ## swc: no ## carpentry: incubator ## carpentry_name: Carpentries Incubator ## carpentry_icon: incubator ## life_cycle: pre-alpha ## pre_alpha: yes ## alpha: no ## beta: no ## stable: no ## doi: ~ ## title: An Example Lesson ## created: '2024-10-15' ## keywords: software, data, lesson, The Carpentries ## episodes: ~ ## learners: ~ ## instructors: ~ ## profiles: ~ ## .present: yes"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/deployment.html","id":"why-r-markdown","dir":"Articles","previous_headings":"","what":"Why R Markdown?","title":"Building and Deployment of a {sandpaper} lesson","text":"decided using R Markdown format powerful tool allows write code text without copy paste output/images/tables. support several languages including python, BASH, SQL. importantly: code rendering features purely optional; can strip away R-associated content left markdown document. system already used R lessons several years works fairly well.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/deployment.html","id":"the-two-step-building-locally","dir":"Articles","previous_headings":"","what":"The Two-Step: Building Locally","title":"Building and Deployment of a {sandpaper} lesson","text":"preview lessons, build static files locally, without servers. possible go directly R Markdown HTML, use two-step process: Generate static markdown source files hash original file YAML header Using external style template, generate website HTML built markdown files NOTE: need make sure renv environment defined lessons, think need happen things released CRAN avoid maxing github api requests. Now, first reaction may , “need two step process can generate HTML directly R Markdown?” answer three-fold. First, R code R Markdown document, takes time execute code add output document. intermediate markdown document contains hash original document, can make sure build files changed content minimal overhead manner compatible R Markdown’s chunk caching feature. Second, generated element page creates invalid HTML, usually causes cascading effect can hard track looking raw HTML output. markdown intermediate allows us easily single potential problems. particular reason important next section scheduled deployments avoid problems raised explicitly checking output. Third, rendered markdown documents makes easy use HTML pandoc templates provided Carpentries. might also wondering “aren’t rendered markdown HTML files tracked git?” answer , , just computer.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/deployment.html","id":"i-deployment-github","dir":"Articles","previous_headings":"","what":"[i] Deployment (GitHub)","title":"Building and Deployment of a {sandpaper} lesson","text":"lesson content auto-generated ecosystem software constantly evolving, ’s important make sure things true: website always available (barring blackouts GitHub) style lessons can updated fly. output lessons match maintainers expect. Changes lesson output easily auditable via git diff. two sources entropy (software environment needed build lesson content CSS/HTML/JS needed create website), ’s important separate steps failure, separate allows us audit failure fix issue appropriate end. Thus, use two-step system presented earlier local rendering, weekly monthly checks: Zooming Pull request workflow can see one point entry. box elements represent user interactions, ellipses GitHub workflows. color indicates permission levels workflows. Lavender workflows ability check code compare . Wheat/yellow colored workflows full permissions push repository: track source files lesson output maintainer’s computer, need rely Continuous Integration rebuild lesson deploy cloud. still use two-step process , difference don’t want make extra commits main branch, instead creating commits two extra directories, create orphan branches called md-sources gh-pages. latter familiar lesson maintainers, former serves staging evaluation area changes generated content. Takeaway diagram: Yes, complex, modularity ensures can replace components without needing significantly modify components. diagram describes dependency graph lesson template. component graph represents either file (beige files/folders/documents) tools (boxes). edges (lines connecting components) categorized following labels: depends (e.g. -> b means component depends component b). usually reserved lesson artifacts generated markdown HTML. component dependent another component, means can exist without upstream component. Changes upstream component can happen independently downstream component, changes affect state downstream component. uses (e.g. -> b means component uses aspects component b). relationship, components independent can change independent one another without necessarily affecting state . contains (e.g. -> b means component contains component b). component contains another component must change contained component changes. example, changes package cache lockfile requires corresponding commit source files. modifies (e.g. -> b means component modifies component b). Modification occurs component agent change downstream component, changes upstream component necessarily correspond change downstream component. example GitHub Actions component one graph can modify components (including ), undergo change update frequency, necessarily affect changes downstream components see.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/deployment.html","id":"push-to-main-branch","dir":"Articles","previous_headings":"[i] Deployment (GitHub)","what":"Push to main branch","title":"Building and Deployment of a {sandpaper} lesson","text":"time commit pushed main branch, command sandpaper::ci_deploy() run GitHub actions render changed source files main md-source apply HTML template, {varnish} files md-source create website. process assumes pushes main branch break rendering process either cosmetic changes changes come pull requests (previously vetted). extra maintainer interaction required.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/deployment.html","id":"pull-requests","dir":"Articles","previous_headings":"[i] Deployment (GitHub)","what":"Pull requests","title":"Building and Deployment of a {sandpaper} lesson","text":"time pull request added, maintainer informed changes lesson (anything), process goes like : pull request triggers new branch md-sources called md-sources-{pr#}. PR built md-sources-{pr#} diff md-sources-{pr#} md-sources added PR comments link. additional commits PR branch rebuilt changes amended md-sources-{pr#} branch (effectively, squash merge) maintainer approves changes, PR gets merged master, site rebuilt source, pr branch removed.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/deployment.html","id":"cron-weekly-updating-the-html-templates","dir":"Articles","previous_headings":"[i] Deployment (GitHub)","what":"CRON: weekly (updating the HTML templates)","title":"Building and Deployment of a {sandpaper} lesson","text":"mentioned , HTML templates live within lesson repository. live {varnish} package applied rendered markdown files. step start md-source branch re-apply fresh version template bring stylistic changes occurred {varnish} repository (e.g. new CSS rules) previous week. step test HTML template working correctly. error occurs, know need fix HTML template lesson. maintainer interaction required.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/deployment.html","id":"cron-monthly-keeping-software-current","dir":"Articles","previous_headings":"[i] Deployment (GitHub)","what":"CRON: monthly (keeping software current)","title":"Building and Deployment of a {sandpaper} lesson","text":"weekly CRON jobs ensure HTML template works, run monthly jobs make sure software stack continues work expected. important making sure generated output matches output learners see narrative additionally matches output. explicitly test changes lesson due changes software stack HTML template. many changes produce technically valid output, Manual inspection diffs required. six steps process, one requires maintainer’s input: new branch created main format YYYY-MM. {renv} configuration file YYYY-MM reset Pull Request created. maintainer follows regular pull request protocol.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/include-child-documents.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Including Child Documents","text":"Writing lesson using Workbench consists writing lesson markdown R Markdown files, placing episodes/ directory defining order files config.yaml file. want author lesson contains content repeated across episodes, {sandpaper} version 0.14, copy paste content across documents, frustrating update line. child documents come . can save repeated snippet markdown inside separate file R Markdown render parent snippet embedded whole time. difference child documents regular episodic content documents independent episodes right. need title, need listed config.yaml, need callout blocks. exist used markdown documents. , recommended make documents overly complex.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/include-child-documents.html","id":"an-example-one-child-document","dir":"Articles","previous_headings":"","what":"An Example: One Child Document","title":"Including Child Documents","text":"can define using child attribute code chunks R Markdown files (note: requires R Markdown). can use many child documents wish, create child files, sure following two rules apply: child documents live files/ folder parent folders reference child files relative parent file. example, file structure like : last lines episodes/introduction.Rmd looks like : can see declaration child document empty code chunk: tells {knitr} take detour render contents files/child.Rmd(relative current working directory, episodes folder). entire document episodes/files/child.Rmd looks like : means episodes/introduction.Rmd built, episodes/files/child.Rmd also built, evaulating sessionInfo(). resulting markdown document look like :","code":"# ./episodes/ # ├── data # ├── fig # ├── files # │ └── child.Rmd # └── introduction.Rmd Cool, right? ```{r si, child=\"files/child.Rmd\"} ``` ::::::::::::::::::::::::::::::::::::: 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 si, child = \"files/child.Rmd\"} ``` ## Session Information The following is the session information of this R session ```{r sessioninfo} sessionInfo() ``` `$\\alpha = \\dfrac{1}{(1 - \\beta)^2}$` becomes: $\\\\alpha = \\\\dfrac{1}{(1 - \\\\beta)^2}$ Cool, right? ## Session Information The following is the session information of this R session ```r sessionInfo() ``` ```output R version 4.4.1 (2024-06-14) Platform: x86_64-pc-linux-gnu Running under: Ubuntu 22.04.5 LTS Matrix products: default BLAS: /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3 LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.20.so; LAPACK version 3.10.0 locale: [1] LC_CTYPE=C.UTF-8 LC_NUMERIC=C LC_TIME=C.UTF-8 [4] LC_COLLATE=C.UTF-8 LC_MONETARY=C.UTF-8 LC_MESSAGES=C.UTF-8 [7] LC_PAPER=C.UTF-8 LC_NAME=C LC_ADDRESS=C [10] LC_TELEPHONE=C LC_MEASUREMENT=C.UTF-8 LC_IDENTIFICATION=C time zone: UTC tzcode source: system (glibc) attached base packages: [1] stats graphics grDevices utils datasets methods base loaded via a namespace (and not attached): [1] compiler_4.4.1 tools_4.4.1 highr_0.11 knitr_1.48 xfun_0.48 [6] evaluate_1.0.1 ``` ::::::::::::::::::::::::::::::::::::: 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 ::::::::::::::::::::::::::::::::::::::::::::::::"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/include-child-documents.html","id":"workspace-consideration","dir":"Articles","previous_headings":"","what":"Workspace consideration","title":"Including Child Documents","text":"{sandpaper} machinery aims keep working space clean possible still allowing authors write way feels natural. processing, assets (.R files, everything files/, fig/, data/) copied source folders site/built/. allows us build R Markdown files using site/built/ working directory accomplishes two things: default sandpaper folder structure flattened website. files R Markdown document creates deletes affect source files project example, let’s say added chunk source R Markdown folder create file data/ directory called “time.txt” reads contents file. lesson gets built, episodes/ directory continue like : Notice file called data/time.txt. file built inside site/built directory. contents directory contains output along files lesson: can see data/, now contains time.txt. rendered Markdown file site/built/introduction.md reflects updates:","code":"--- title: 'introduction' teaching: 10 exercises: 2 --- ```{r setup, echo=FALSE} writeLines(format(Sys.time()), 'data/time.txt') cat(paste0('The time is: ', readLines('data/time.txt'))) ``` # ./episodes/ # ├── data # ├── fig # ├── files # │ └── child.Rmd # └── introduction.Rmd # ./site/built/ # ├── CODE_OF_CONDUCT.md # ├── LICENSE.md # ├── config.yaml # ├── data # │ └── time.txt # ├── fig # │ └── introduction-rendered-pyramid-1.png # ├── files # │ └── child.Rmd # ├── index.md # ├── instructor-notes.md # ├── introduction.md # ├── learner-profiles.md # ├── links.md # ├── md5sum.txt # ├── reference.md # └── setup.md --- title: 'introduction' teaching: 10 exercises: 2 --- ```output The time is: 2024-10-15 13:31:19 ```"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/include-child-documents.html","id":"child-document-assets","dir":"Articles","previous_headings":"","what":"Child document assets","title":"Including Child Documents","text":"use child file, best avoid relying assets external child document . decide reference assets, child documents need assets written already embedded build parent. case, say build parent, refering final parent child document output eventually end . Let’s say wanted refererence figure episodes/fig/one.png link document learners learners/info.md child document, instead ’s located episodes/files/children/child.Rmd, built episodes/introduction.Rmd. parent document (episodes/introduction.Rmd) referencing child document look like : episodes/files/children/child.Rmd, internal link rules, reference resources fig/one.png ../learners/info.md, context build parent directory (case, episodes/), demonstrated : , reason document gets built, result context parent document site/built directory1: makes sense site/built/introduction.md:","code":"# ./episodes/ # ├── data # ├── fig # │ └── one.png # ├── files # │ └── children # │ └── child.Rmd # └── introduction.Rmd Cool, right? ```{r si, child=\"files/children/child.Rmd\"} ``` ::::::::::::::::::::::::::::::::::::: 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 :::::::::::::::::::::::::::::::::::::::::::::::: Here is a link to [the info document](../learners/info.md) {alt='example figure'} ## Session Information The following is the session information of this R session ```{r sessioninfo} sessionInfo() ``` # ./site/built/ # ├── CODE_OF_CONDUCT.md # ├── LICENSE.md # ├── config.yaml # ├── data # │ └── time.txt # ├── fig # │ ├── introduction-rendered-pyramid-1.png # │ └── one.png # ├── files # │ └── children # │ └── child.Rmd # ├── index.md # ├── info.md # ├── instructor-notes.md # ├── introduction.md # ├── learner-profiles.md # ├── links.md # ├── md5sum.txt # ├── reference.md # └── setup.md Cool, right? Here is a link to [the info document](../learners/info.md) {alt='example figure'} ## Session Information The following is the session information of this R session ```r sessionInfo() ``` ```output R version 4.4.1 (2024-06-14) Platform: x86_64-pc-linux-gnu Running under: Ubuntu 22.04.5 LTS Matrix products: default BLAS: /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3 LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.20.so; LAPACK version 3.10.0 locale: [1] LC_CTYPE=C.UTF-8 LC_NUMERIC=C LC_TIME=C.UTF-8 [4] LC_COLLATE=C.UTF-8 LC_MONETARY=C.UTF-8 LC_MESSAGES=C.UTF-8 [7] LC_PAPER=C.UTF-8 LC_NAME=C LC_ADDRESS=C [10] LC_TELEPHONE=C LC_MEASUREMENT=C.UTF-8 LC_IDENTIFICATION=C time zone: UTC tzcode source: system (glibc) attached base packages: [1] stats graphics grDevices utils datasets methods base loaded via a namespace (and not attached): [1] compiler_4.4.1 tools_4.4.1 highr_0.11 knitr_1.48 xfun_0.48 [6] evaluate_1.0.1 ``` ::::::::::::::::::::::::::::::::::::: 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 ::::::::::::::::::::::::::::::::::::::::::::::::"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/include-child-documents.html","id":"what-happens-if-we-use-relative-links-here","dir":"Articles","previous_headings":"Child document assets","what":"What happens if we use relative links here?","title":"Including Child Documents","text":"use relative links child document, find warnings missing files validation:","code":"#> ── Validating Fenced Divs ────────────────────────────────────────────── #> ── Validating Internal Links and Images ──────────────────────────────── #> ! There were errors in 2/39 links and images #> ◌ Some linked internal files do not exist <https://carpentries.github.io/sandpaper/articles/include-child-documents.html#workspace-consideration> #> #> ::warning file=episodes/files/children/child.Rmd,line=1:: [missing file (relative to episodes/)]: [the info document](../../../learners/info.md) #> ::warning file=episodes/files/children/child.Rmd,line=3:: [missing file (relative to episodes/)]: [example](../../fig/one.png)"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/include-child-documents.html","id":"child-documents-of-child-documents","dir":"Articles","previous_headings":"","what":"Child documents of child documents","title":"Including Child Documents","text":"also possible reference child documents within child document, , child documents paths must relative build parent path Thus, child document calling second child document, must write relative path build parent. means want reference episodes/files/child-two.md episodes/files/child-one.Rmd, must write way: episodes/files/child-one.Rmd:","code":"```{r child='files/child-two.md'} ```"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/internationalisation.html","id":"structural-elements-l10n","dir":"Articles","previous_headings":"","what":"Structural Elements (l10n)","title":"Internationalisation (i18n) and Localisation (l10n)","text":"first issue common websites several available solutions exits several languages. moment, Carpentries website supports l10n low-rent manner including yaml dictionary _data directory switching languages via site.data.language variable (shown example translates “content open source”). Though, exactly accessible via main site clear. make sure translations compatible matter tooling use (R, Python, JavaScript, PhP), store translations *.po (portable object) language can use gettext() utility swap translations. associated lesson template , *po files live {varnish} package used R translate messages website generated.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/internationalisation.html","id":"references-and-definitions","dir":"Articles","previous_headings":"","what":"References and Definitions","title":"Internationalisation (i18n) and Localisation (l10n)","text":"References definitions achieved via {glosario} project glossary formatted yaml file python, R libraries can used extract specific translations glossaries.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/internationalisation.html","id":"page-content-i18n","dir":"Articles","previous_headings":"","what":"Page Content (i18n)","title":"Internationalisation (i18n) and Localisation (l10n)","text":"topic currently well addressed quite hard translating prose much harder translating individual messages context individual paragraph section important. David Pérez-Suárez proposed use {gettext} solution standard translating messages several computer programs. found python + BASH project called po4gitbook convert markdown content po files translation back . However, ’s finding breaks lot parsing markdown elements like lists R chunks. ’m thinking solution use parse markdown commonmark XML spec use extract paragraph elements, recast markdown use basis translated messages. way, parsing won’t issue. big challenge library re-written happen.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Landscape View of New Lesson Template","text":"new lesson infrastructure lot moving parts, built solid foundation clearly separates content tooling needed. Importantly, order use infrastructure, need know much works hood. Importantly: beginner’s guide. looking resource, head sandpaper documentation site. document serves kind “nerd’s guide” lesson infrastructure. steps back takes landscape-level view infrastructure works differs previous infrastructure.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"motivation","dir":"Articles","previous_headings":"Introduction","what":"Motivation","title":"Landscape View of New Lesson Template","text":"lesson maintainers contributors volunteers, means limited amount time work lessons. lesson infrastructure simple framework contributors maintainers write lessons way maximizes attention lesson content.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"difficulties-with-the-previous-infrastructure","dir":"Articles","previous_headings":"Introduction","what":"Difficulties with the previous infrastructure","title":"Landscape View of New Lesson Template","text":"Jekyll-based lesson template showing age recently ’s clear refresh sorely needed. Chief among issues Jekyll template currently requires 4 languages (top Git) minimum installed order preview locally: Ruby, Python, Bash, Make. setup represents large barrier people coming lesson maintenance first time clearly issue include videos people use github-based workaround preview lessons. Beyond initial setup contributors, another pain point reliance styles inside lesson convoluted manner lesson must created: must imported carpentries/styles repository history preserved maintainer can initialize lesson. time comes update lesson, expect maintainer touched styling elements machinery merge happens conflicts, rarely case initiate merge fix conflicts. inspect process adding updating content lesson, find still places frustration. configuration file contains several pieces information necessary site, must never touched. Moreover, header yaml lesson contains three lists, objectives, keypoints, questions, formatted strings included body rendered lesson. issue ’s easy become invalid due misplaced punctuation. Linking images lived top repository difficult authoring special block quotes challenging writing content always preceded > proved error prone.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"what-the-new-infrastructure-will-bring","dir":"Articles","previous_headings":"Introduction","what":"What the new infrastructure will bring","title":"Landscape View of New Lesson Template","text":"new lesson infrastructure, strive clear template clutter allow contributors focus important: lesson content written clear easy--read markdown. Importantly, lessons still portable customisable engine, validator, styling live separate independent software packages. Lessons official Carpentries GitHub accounts also benefit automation provide timely updates elements needed build lessons (case lessons generated output). document outline aspects new lesson template describe organized aspects including folder structure lesson, content specifications episode, content specifications extra-episode files (e.g. references), toolchain landscape, local build requirements, deployment specifications, internationalization (i18n) specifications.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"notation","dir":"Articles","previous_headings":"","what":"Notation","title":"Landscape View of New Lesson Template","text":"document intended extensive targeted lesson maintainers infrastructure team. overly-detailed descriptions infrastructure maintainers required know, label points [] maintainers can skip sections needed.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"foundation-structure-of-the-lesson-template","dir":"Articles","previous_headings":"","what":"Foundation: Structure of the Lesson Template","title":"Landscape View of New Lesson Template","text":"section discuss structure template terms file organization go aspects specific tools. new lesson template designed mimic aspects previous template. template designed primarily use Carpentries, theoretically extensible contexts. importantly, contributors expected know markdown minimal yaml syntax. order contribute lessons. Thus, rules new template follow: main branch source truth protected Accessibility priority lesson based WCAG 2.1 guidelines style lessons live template committed content content directly maintainer/contributor configuration files Episodes depend lesson template rendered generated lesson web page exist stand-alone directory can shared offline","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"accessibility","dir":"Articles","previous_headings":"","what":"Accessibility","title":"Landscape View of New Lesson Template","text":"exceptions, lessons shown largely accessible thanks reliance modern frameworks hosting lessons. said, occasional issues WCAG 2.1 accessibility guidelines provides roadmap ensure lessons Perceivable, Operable, Understandable, Robust.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"lesson-folder-organization","dir":"Articles","previous_headings":"","what":"Lesson Folder Organization","title":"Landscape View of New Lesson Template","text":"lesson template organized clearly separates lesson content lesson style:","code":"|-- .gitignore # - Ignore everything in the site/ folder |-- .github/ # - Scripts used for continuous integration |-- episodes/ # - PUT YOUR MARKDOWN FILES IN THIS FOLDER | |-- data/ # -- Data for your lesson goes here | |-- figures/ # -- All static figures and diagrams are here | |-- files/ # -- Additional files (e.g. handouts) | `-- 00-introducition.Rmd # -- Lessons start with a two-digit number |-- instructors/ # - Information for Instructors | `-- instructor-notes.md # -- placeholder |-- learners/ # - Information for Learners | `-- setup.md # -- setup instructions (REQUIRED) |-- profiles/ # - Learner and/or Instructor Profiles | `-- learner-profiles.md # -- placeholder |-- renv/ # - Local package cache |-- site/ # - This folder is where the rendered markdown | | files and static site will live | `-- README.md # -- placeholder |-- config.yaml # - Use this to configure commonly used variables |-- index.md # - Front page for the site |-- CONTRIBUTING.md # - Carpentries Rules for Contributions (REQUIRED) |-- CODE_OF_CONDUCT.md # - Carpentries Code of Conduct (REQUIRED) |-- LICENSE.md # - Carpentries Licenses (REQUIRED) `-- README.md # - Introduces folks how to use this lesson and # where they can find more information."},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"episodes","dir":"Articles","previous_headings":"Lesson Folder Organization","what":"Episodes","title":"Landscape View of New Lesson Template","text":"episodes content required episodes go episodes/ folder (note underscore prefix) extract episodes folder give someone else, able execute RMarkdown documents project using method see fit.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"configuration","dir":"Articles","previous_headings":"Lesson Folder Organization","what":"Configuration","title":"Landscape View of New Lesson Template","text":"file config.yaml minimal yaml file contains metadata lesson-wide aspects (Author, Carpentry, Licence, Title, etc.) along specifications episodes extras included dropdown menus.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"generated-files","dir":"Articles","previous_headings":"Lesson Folder Organization","what":"Generated Files","title":"Landscape View of New Lesson Template","text":"two sources generated files template explicitly tracked git, live site/ directory: static markdown cache generated source files local preview HTML files, generated static markdown files. Separating content generation episode assembly HTML site gives us couple advantages: can cache episodes content generation HTML styling tools needed generate static markdown documents need tools needed apply HTML template (e.g. potentially feasible workflow renders Jupyter Notebook -> Markdown instead RMarkdown -> Markdown). error occurs, assess process source error require sifting HTML diffs. two step process explained Two-Step: Building Locally.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"i-static-markdown-cache","dir":"Articles","previous_headings":"Lesson Folder Organization > Generated Files","what":"[i] Static Markdown Cache","title":"Landscape View of New Lesson Template","text":"static markdown cache files live site/built contain static markdown documents generated output special item yaml header called sandpaper-digest. value item md5 sum corresponding source file tool chain can determine files need rebuilt.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"local-preview-html","dir":"Articles","previous_headings":"Lesson Folder Organization > Generated Files","what":"Local Preview HTML","title":"Landscape View of New Lesson Template","text":"local preview generated website live site/docs folder. site generated static markdown cache site/built source. site/docs folder can shared anywhere fully-functional static website. Many javascript CSS elements sourced CDNs, can also bundled directly site (increases size storage).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"portable-html-lesson","dir":"Articles","previous_headings":"Lesson Folder Organization > Generated Files","what":"Portable HTML Lesson","title":"Landscape View of New Lesson Template","text":"thing preventing lessons used offline fact rely CSS/JS framework delivered CDN, may feasible workshops taught regions internet connectivity limited (though browser cache takes care part). accomodate , procedure creates standalone folder lesson writes outside repository can copied flash drive delivered via local WiFi router.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"episode-structure","dir":"Articles","previous_headings":"","what":"Episode Structure","title":"Landscape View of New Lesson Template","text":"episodes Carpentries stand-alone markdown documents can render valid HTML via pandoc without external dependencies. structure episode largely free-form, certain elements included ensure valid episode form yaml content, required information blocks, instructor notes, properly closed fenced div tags. refresher, fenced div tag line starts least three colons followed name tag. tag closed adding another line starts least three colons tag end: convention, use much 3 : characters clearly indicate block created.","code":"::::::::::::::::::::::::::: challenge This is a *challenge block* ::::::::::::::::::::::::::::::::::::::"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"yaml-metadata","dir":"Articles","previous_headings":"Episode Structure","what":"YAML metadata","title":"Landscape View of New Lesson Template","text":"YAML metadata contain three elements, title, teaching, exercises. title character string title. Markdown can used title. teaching exercises number cumulative minutes required teach lesson complete exercises, respectively. used populate syllabus beginning lesson","code":"title: \"Creating Examples: Yes, These *Are* Difficult\" teaching: 20 exercises: 10"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"required-information-blocks","dir":"Articles","previous_headings":"Episode Structure","what":"Required Information Blocks","title":"Landscape View of New Lesson Template","text":"Objectives (top) - One three statements describes broad concepts learners get lesson Questions (top) - One three questions learners ask start lesson Keypoints (bottom) - point--point reinforcement covered lesson reduce amount friction contributors write displayed lesson, placement enforced validation procedure validated checking proximity blocks elements document XML representation. blocks comply, human-readable alert generated indicating block moved (example error):","code":"Error: File: '/path/to/episode.Rmd' The Questions block should be at the top of the document (lines AA--BB). Instead, they are located at lines XX--YY. Please edit '/path/to/episode.Rmd' and move the block at lines XX--YY to the top of the document (lines AA--BB)."},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"instructor-notes","dir":"Articles","previous_headings":"Episode Structure","what":"Instructor Notes","title":"Landscape View of New Lesson Template","text":"Carpentries lessons traditionally kept instructor notes separate page lessons, lead notes used confusion use . proposed keep instructor notes inside lessons risk creating longer even complicated structure maintainers keep track . acommodate , propose new class tag called instructor, hidden default toggle can display notes alongside lesson. instructor tag tags, starting least three colons ending least three colons: Practically, instructor notes lesson, rendered separate pages placed file called instructor/ can accessed via /path//lesson/instructor/page.html","code":":::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: instructor ## SLOW DOWN :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"fenced-div-tags","dir":"Articles","previous_headings":"Episode Structure","what":"Fenced Div Tags","title":"Landscape View of New Lesson Template","text":"open tags must balanced closing tag. specification fenced divs fairly loose, clarity’s sake, rules thumb. tags necessarily color-coded, ’s good idea differentiate tags length. need specific length, ’s good idea make sure different level tags clearly visible. Instructor tags largest. Aim fences span across document (~80 characters). Top-level tags span least half document (~50 characters). Nested tags (e.g. solution) span quarter document (~25 characters).","code":"# Lesson 1 This is an example lesson. :::::::::::::::::::::::::::::::::::::: objectives - Write good ::::::::::::::::::::::::::::::::::::::::::::::::: :::::::::::::::::::::::::::::::::::: questions - Is it okay if the number of colons don't match up? - Are the sections visible? :::::::::::::::::::::::::::::::::::::::::::::::: ## Introduction Writing tags looks like a bunch of `:` elements. :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: instructor ### Example This is an example of how you write an instructor tag ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: Let's try a challenge. :::::::::::::::::::::::::::::::::::::: challenge Write a solution ::::::::::::::: solution NaCl + H2O :::::::::::::::::::::::: ::::::::::::::::::::::::::::::::::::::::::::::::"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"links","dir":"Articles","previous_headings":"Episode Structure","what":"Links","title":"Landscape View of New Lesson Template","text":"Carpentries Lessons, contributors need ways specifying links can access part lesson online offline. also need make sure links preserve integrity incoming links people linked lessons past want discover links suffering rot. ultimate goal make sure lesson contributors authors think much beyond see order create link. simplest way authors use relative links html tag end: Link episodes: use [link text](episode-name.html) Link figure episode: use  Link references extras folder: [link text](../extras/references.html)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"code-blocks","dir":"Articles","previous_headings":"Episode Structure","what":"Code Blocks","title":"Landscape View of New Lesson Template","text":"Code Blocks lesson formatted way code blocks formatted commonmark. represented three backtics followed language want use syntax highlighting block.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"evaluation","dir":"Articles","previous_headings":"Episode Structure > Code Blocks","what":"Evaluation","title":"Landscape View of New Lesson Template","text":"encouraging use RMarkdown, can code blocks actually evaluate code using RMarkdown chunk syntax three backtics followed pair curly braces name language engine want use executing code blocks. moment, explicitly support evaluation R BASH, gathering input maintainers processes expand. One promising project Quarto, extends functionality R Markdown languages cross-platform, stand-alone binary program. large list language engines RMarkdown supports. engines require language available PATH share variables values chunks, lesson authors need explicit installation requirements lessons. languages like Python, Julia, SQL can share data variables chunks help specific packages (e.g. {reticulate} Python, {JuliaCall} Julia, {DBI} SQL databases).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"basic-infrastructure-for-maintainers","dir":"Articles","previous_headings":"","what":"Basic Infrastructure for Maintainers","title":"The nerd's guide to the lesson toolchain","text":"manage render lessons, need following software installed. dependencies R packages automatically install. {sandpaper} {varnish} RStudio (>= 1.4) pandoc (>= 2.11) Modern Web Browser Git (>= 2.0) {renv}","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"the-source-of-truth-dependency-management","dir":"Articles","previous_headings":"","what":"The Source of Truth: Dependency Management","title":"The nerd's guide to the lesson toolchain","text":"Python R package ecosystem constantly evolving, can often create different outputs one maintainer’s computer . Moreover, maintain lesson, may want update package using thesis work. alleviate problems, use {renv} R package managing dependencies lessons. managing dependencies, {renv} serves two roles: Package discovery {renv} scan packages declared lesson install computer Package management Lessons use {renv} maintains custom lockfile contains packages required build lesson specific versions, ensuring lesson can reliably reproduced across computers. point, {renv} required building lesson even generated content. can find use {renv} build process reading Building Lessons Package Cache vignette.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"for-markdown-only-lessons","dir":"Articles","previous_headings":"The Source of Truth: Dependency Management","what":"For Markdown-Only Lessons","title":"The nerd's guide to the lesson toolchain","text":"markdown-lesson evaluated code (, copy paste output learners see), need worry dependency management beyond basic infrastructure (taken care automatically).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"for-rmarkdown-lessons-r-bash-python-sql","dir":"Articles","previous_headings":"The Source of Truth: Dependency Management","what":"For RMarkdown Lessons (R, BASH, Python, SQL)","title":"The nerd's guide to the lesson toolchain","text":"lesson uses RMarkdown evaluate code produce output, utmost importance dependencies managed properly lesson. Like Jekyll-based lesson template, take care making sure dependencies okay, difference now ask approve everyone experience. {renv} package relatively stripped-interface, wanted provide opinionated solution management. example, learners advised install anaconda, also encourage recommend. {renv} package aware R Python dependencies, can install add packages lesson usual run single command sandpaper::deps() check update dependencies. Python dependencies live environment.yml file root lesson. moment, bit lives shaky foundation","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"carpentries-specific-packages","dir":"Articles","previous_headings":"","what":"Carpentries-Specific Packages","title":"The nerd's guide to the lesson toolchain","text":"created three R packages designed work explicitly lessons. automatically installed special configuration file inside lesson repository.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"lesson-template-sandpaper","dir":"Articles","previous_headings":"Carpentries-Specific Packages","what":"Lesson Template ({sandpaper})","title":"The nerd's guide to the lesson toolchain","text":"{sandpaper} package creates curates lesson template. package maintainers lesson template need interface . majority maintainers need one function: build_lesson(), evaluate new content render HTML page local machine.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"i-key-packages","dir":"Articles","previous_headings":"Carpentries-Specific Packages > Lesson Template ({sandpaper})","what":"[i] Key Packages","title":"The nerd's guide to the lesson toolchain","text":"{sandpaper} package relies heavily packages internally make sure reinvent wheel much gain benefits tests: {pkgdown} provides scaffolding us able wrap HTML (translated markdown) metadata framework can live separately lesson template. {knitr} engine use translate RMarkdown Markdown without styling output document. {rmarkdown} provides functions give us access pandoc. moment, function use RMarkdown pandoc_convert() transform markdown HTML. {usethis} provides user interface functions creating projects working github. {gert} gives users access git R without need installed.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"i-html-template-varnish","dir":"Articles","previous_headings":"Carpentries-Specific Packages","what":"[i] HTML Template ({varnish})","title":"The nerd's guide to the lesson toolchain","text":"{varnish} package contains template HTML written {{mustache}} templating language. used {sandpaper}, explicitly imported updating can done inside R.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"framework","dir":"Articles","previous_headings":"Carpentries-Specific Packages > [i] HTML Template ({varnish})","what":"Framework","title":"The nerd's guide to the lesson toolchain","text":"NOTE: section needs work information. framework inside {varnish} needs extensible , importantly, separate logic needed create source documents. moment, using bootstrap version 3, version officially deprecated last two years.. moment, two frameworks widely used within R community, bootstrap, distill. benefits distill ’s really nice including citation metadata, one downsides absolutely requires JavaScript enabled (can security risk).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"i-lesson-validation-and-transformation-pegboard","dir":"Articles","previous_headings":"Carpentries-Specific Packages","what":"[i] Lesson Validation and Transformation ({pegboard})","title":"The nerd's guide to the lesson toolchain","text":"{pegboard} package uses {tinkr} package read markdown XML validate structure schema validate internal structure lessons.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Translating The Workbench","text":"philosophy Carpentries Workbench one separation lesson content tooling needed transform content website. possible write lesson human language syllabary can represented computer. catch : default language website template—navigational elements website—English, authors need tell Workbench language website template use. write lesson specific language, lesson author add lang: 'xx' config.yaml file xx represents language code matches language lesson content. defaults \"en\", can language code (e.g. “ja” specifying Japanese) combination language code country code (e.g. “pt_BR” specifies Pourtugese used Brazil). information used, see Locale Names section gettext manual. country-specific variation language needs added, necessary re-translate everything identical original language file—need translate different. Setting lang: keyword allow lesson navigational elements website template presented language lesson content language added {sandpaper}. , menu items appear English. vignette interest wish update translations add new translations. vignette provide resources updating adding new languages, process translation happens, outline special syntax used {sandpaper}.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"recommended-tools","dir":"Articles","previous_headings":"Resources","what":"Recommended Tools","title":"Translating The Workbench","text":"provide translations non-maintainer, need text editor add translations strings present .po translation files (see files Translating {sandpaper} section. like compile test translations locally, need {potools} package, requires GNU gettext system. mentioned {potools} installation documentation, macOS, likely need use brew install gettext brew install gettext, otherwise, bundled RTools (needed package development Windows) present Linux distributions.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"documentation","dir":"Articles","previous_headings":"Resources","what":"Documentation","title":"Translating The Workbench","text":"documentation {potools} package wonderful resource. Use vignette(\"translators\", package = \"potools\") read details consider translating text package. Another really good resource blog post Maëlle Salmon gives minimum working example translating package messages using {potools}. interested translating lesson content, please consult Joel Nitta’s Carpentries translation guide. can use tools Joel Nitta’s {dovetail} providing method translators track deploy translations Carpentries lessons. can also use rOpenSci’s {babeldown}, uses DeepL API automated translation translators can edit afterwards.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"translating-in-sandpaper","dir":"Articles","previous_headings":"","what":"Translating in {sandpaper}","title":"Translating The Workbench","text":"translations {sandpaper} mostly shuffled {varnish}, template variables written mustache templating. variables define visible menu text “Key Points” screen-reader accessible text buttons “close menu”. 6 languages known {sandpaper}: en de es fr ja uk language known {sandpaper} lesson attempts use language, default back English (source language).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"the-source-files-of-translations","dir":"Articles","previous_headings":"Translating in {sandpaper}","what":"The source files of translations","title":"Translating The Workbench","text":"translate {sandpaper}, working .po files, text files live po/ folder source package. one .po file per language translated. syntax looks like , first line shows file translation exists, second line gives message English, third line gives translation: files recognised several well-established graphical user interfaces, since text files, can edit text editor GitHub directly.","code":"#: build_404.R:57 msgid \"Page not found\" msgstr \"ページが見つかりません\""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"how-translations-are-processed-in-r","dir":"Articles","previous_headings":"Translating in {sandpaper}","what":"How translations are processed in R","title":"Translating The Workbench","text":"po files compiled binary .mo files carried built package user’s computer. files used R function base::gettext() translate messages specific context. context {sandpaper} known R-sandpaper. language exist, revert English: make translation keys easier detect, internal convenience function, tr_() defined, addition, source strings keys translations can found tr_src(), tr_varnish() tr_computed(), want find context given translation key, can find searching source code tr_.","code":"library(\"withr\") library(\"sandpaper\") known_languages() #> [1] \"en\" \"de\" \"es\" \"fr\" \"ja\" \"uk\" with_language(\"ja\", { enc2utf8(gettext(\"Page not found\", domain = \"R-sandpaper\")) }) #> [1] \"ページが見つかりません\" with_language(\"en\", { enc2utf8(gettext(\"Page not found\", domain = \"R-sandpaper\")) }) #> [1] \"Page not found\" with_language(\"xx\", { enc2utf8(gettext(\"Page not found\", domain = \"R-sandpaper\")) }) #> [1] \"Page not found\""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"special-syntax-for-translators","dir":"Articles","previous_headings":"Translating in {sandpaper}","what":"Special syntax for translators","title":"Translating The Workbench","text":"content translation requires variables markup added translation. Items {curly_braces} variables remain English: Words <(kirby quotes)> HTML markup surrounding translated:","code":"#: utils-translate.R:52 msgid \"Estimated time: {icons$clock} {minutes} minutes\" msgstr \"所要時間：{icons$clock} {minutes}分\" #: utils-translate.R:62 msgid \"This lesson is subject to the <(Code of Conduct)>\" msgstr \"このレッスンは<(行動規範)>の対象となります\""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"updates-to-translations","dir":"Articles","previous_headings":"Translating in {sandpaper}","what":"Updates to translations","title":"Translating The Workbench","text":"may times future translations need updated text changes added. happens, maintainer {sandpaper} run following commands extract new translation strings, update languages, recompile .mo files built package. languages updated, translation utility attempt make fuzzy matches create new strings. example, update “Page found” translation title case, add punctuation little whimsy \"Page? Found! -_-;\", go edit translation, might see something like : old translation used translator updates runs potools::po_compile() update .mo files. new strings translations added, translation utility assume know anything translation appear like : translation available given string, default string :","code":"potools::po_extract() potools::po_update() potools::po_compile() #: build_404.R:57 #, fuzzy #| msgid \"Page not found\" msgid \"Page? Not Found! -_-;\" msgstr \"ページが見つかりません\" #: build_404.R:57 msgid \"A new translation approaches!\" msgstr \"\" with_language(\"ja\", { enc2utf8(gettext(\"A new translation approaches!\", domain = \"R-sandpaper\")) }) #> [1] \"A new translation approaches!\""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"list-of-translation-variables","dir":"Articles","previous_headings":"","what":"List of Translation Variables","title":"Translating The Workbench","text":"62 translations generated set_language() correspond following variables varnish: addition, 26 translations inserted get varnish:","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Robert Davey. Author, maintainer. Erin Becker. Author. Zhian N. Kamvar. Author. Julien Colomb. Contributor. Ben Companjen. Contributor. Toby Hodges. Contributor. François Michonneau. Contributor. Kelly Barnes. Contributor. Hugo Gruson. Contributor. Milan Malfait. Contributor. Joel H. Nitta. Author, translator. Yanina Bellini Saibene. Contributor, translator. Martin Raden. Contributor, translator.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Davey R, Becker E, Kamvar Z, Nitta J (2024). sandpaper: Create Curate Carpentries Lessons. R package version 0.16.9.9000, https://github.com/carpentries/sandpaper/, https://carpentries.github.io/workbench/, https://carpentries.github.io/sandpaper/.","code":"@Manual{, title = {sandpaper: Create and Curate Carpentries Lessons}, author = {Robert Davey and Erin Becker and Zhian N. Kamvar and Joel H. Nitta}, year = {2024}, note = {R package version 0.16.9.9000, https://github.com/carpentries/sandpaper/, https://carpentries.github.io/workbench/}, url = {https://carpentries.github.io/sandpaper/}, }"},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"sandpaper-user-interface-to-the-carpentries-workbench-","dir":"","previous_headings":"","what":"The Carpentries Lesson Infrastructure Engine","title":"The Carpentries Lesson Infrastructure Engine","text":"{sandpaper} package created Carpentries re-imagine method creating lesson websites workshops. package take series Markdown RMarkdown files generate static website features styling Carpentries lessons including customized layouts callout blocks. Much functionality package inspired Jenny Bryan’s work {usethis} package.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"documentation","dir":"","previous_headings":"","what":"Documentation","title":"The Carpentries Lesson Infrastructure Engine","text":"Want know works lesson format? Head https://carpentries.github.io/sandpaper-docs/. , instead, already know lesson built interested understanding functions {sandpaper} work, can visit package documentation site https://carpentries.github.io/sandpaper/.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"The Carpentries Lesson Infrastructure Engine","text":"{sandpaper} currently CRAN, can installed Carpentries Universe (updated every hour) following commands: Note also install development versions following packages:","code":"options(repos = c( carpentries = \"https://carpentries.r-universe.dev/\", CRAN = \"https://cran.rstudio.com/\" )) install.packages(\"sandpaper\", dep = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"design","dir":"","previous_headings":"","what":"Design","title":"The Carpentries Lesson Infrastructure Engine","text":"package designed make life lesson contributors maintainers easier separating tools needed build site user-defined content site . longer rely Jekyll >450 static site generators, instead rely R, RStudio, {pkgdown} generate site following features: optional offline use filename-agnostic episode arrangements clear definitions package versions needed build lesson lesson versioning (e.g. can navigate https://swcarpentry.github.io/python-novice-gapminder current version https://swcarpentry.github.io/python-novice-gapminder/2020-11 release 2020-11) seamless updates Carpentries’ style caching rendered content rapid deployment packaging {learnr} materials validation lesson structure git aware, require contributors git installed","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"rendering-locally","dir":"","previous_headings":"Design","what":"Rendering locally","title":"The Carpentries Lesson Infrastructure Engine","text":"local two-step model deployment local folders repository generated via {sandpaper}, source committed avoid issues surrounding --date artefacts directory structure confusion. website generated two steps: markdown files source files rendered containing hash source file need re-rendered change. html files generated rendered markdown files CSS JS sources {varnish} package preview. ensure clashes minor differences user setup, artifacts committed main branch repository. caching mechanism website rendered markdown files, long-running lessons can updated previewed quickly.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"rendering-on-continuous-integration","dir":"","previous_headings":"Design","what":"Rendering on continuous integration","title":"The Carpentries Lesson Infrastructure Engine","text":"Two-step deployment model continuous integration Continuous integration act single source--truth outputs lessons rendered. , want resulting website : CI agnostic (currently set GitHub) easy set auditable (e.g. can see changes content two commits) versionable (e.g. can instruct learners go <WEBSITE>/1.1. inspired python documentation style) acheive , two branches created: md-outputs gh-pages inerit like main -> md-outputs -> gh-pages. build time main md-outputs can time intensive, default updating files changed. md-outputs: branch contain files artifacts generated rmarkdown vignettes directory thin package skeleton. gh-pages: branch generated via md-outputs bundles html, css, js website. contain single index.html file several subfolders different versions site. index.html file redirect current/ directory, contains --date site.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"scheduled-builds","dir":"","previous_headings":"Design > Rendering on continuous integration","what":"Scheduled builds","title":"The Carpentries Lesson Infrastructure Engine","text":"gh-pages website: designing lessons content separated styling, set CI generate webpage pre-built sources weekly basis, check update styles ({varnish} package) rebuild site without rebuilding content. md-outputs branch: rerun every month scratch recent version R R packages. change, pull request can generated update renv.lock file link changed markdown files branch.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"function-syntax","dir":"","previous_headings":"Design","what":"Function syntax","title":"The Carpentries Lesson Infrastructure Engine","text":"functions {sandpaper} following prefixes: create_ create/amend files folders workspace update_ update build resources lesson build_ build files source check_ validates either elements lesson /episodes fetch_ download files resources internet reset_ removes files information get_ retrieve information source files R object set_ update information files. ci_ interacts continous integration build website working list user-facing functions: Lesson Episode Creation create_lesson() creates lesson scratch create_episode() creates new episode correct number prefix create_dataset() creates csv text data set R object set_episodes() arranges episodes user-specified order Accessors get_config() reads contents config.yaml list get_drafts() reports files listed config.yaml get_episodes() returns episode filenames vector get_syllabus() returns syllabus timings, titles, questions Website Creation Validation check_lesson() checks validates source files lesson structure build_episode_md() renders individual file markdown (internal use) build_episode_html() renders built markdown file html (internal use) build_lesson() builds lesson static website build_portable_lesson() builds lesson portable static website fetch_lesson() fetches static website lesson repository Continuous Integration Utilities ci_deploy() builds deploys lesson CI source files ci_build_markdown() builds markdown files CI source deploys markdown branch. ci_build_site() deploys lesson CI pre-rendered markdown files ci_release() builds deploys lesson CI source files adds release tag update_github_workflows() updates GitHub workflows Cleanup reset_episodes() removes schedule config.yaml file reset_site() clears website cache","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"The Carpentries Lesson Infrastructure Engine","text":"five use-cases {sandpaper}: Creating lessons Contributing lessons Maintaining lessons Rendering portable site Rendering site GitHub actions.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"creating-a-lesson","dir":"","previous_headings":"Usage","what":"Creating a lesson","title":"The Carpentries Lesson Infrastructure Engine","text":"create lesson {sandpaper}, use create_lesson() function: create folder desktop called r-intermediate-penguins following structure: site set , can add RMarkdown files episodes folder. default, built alphabetical order, can use set_episodes() command build schedule config.yaml file: want preview site, use following: using RStudio, can preview lesson site using keyboard shortcut ctrl + shift + B (corresponds “Build Website” button “Build” tab. preview individual files, can use ctrl + shift + K (corresponds “Knit” button editor pane) create website structure inside site/ folder, render RMarkdown files markdown (inspection quick rendering), render markdown files HTML, enable preview within browser window.","code":"sandpaper::create_lesson(\"~/Desktop/r-intermediate-penguins\") |-- .gitignore # - Ignore everything in the site/ folder |-- .github/ # - Scripts used for continuous integration | `-- workflows/ # | |-- deploy-site.yaml # - Build the source files on github pages | |-- build-md.yaml # - Build the markdown files on github pages | `-- cron.yaml # - reset package cache and test |-- episodes/ # - PUT YOUR MARKDOWN FILES IN THIS FOLDER | |-- data/ # - Data for your lesson goes here | |-- figures/ # - All static figures and diagrams are here | |-- files/ # - Additional files (e.g. handouts) | `-- 00-introducition.Rmd # - Lessons start with a two-digit number |-- instructors/ # - Information for Instructors |-- learners/ # - Information for Learners | `-- setup.md # - setup instructions (REQUIRED) |-- profiles/ # - Learner and/or Instructor Profiles |-- site/ # - This folder is where the rendered markdown files and static site will live | `-- README.md # - placeholder |-- config.yaml # - Use this to configure commonly used variables |-- CONTRIBUTING.md # - Carpentries Rules for Contributions (REQUIRED) |-- CODE_OF_CONDUCT.md # - Carpentries Code of Conduct (REQUIRED) |-- LICENSE.md # - Carpentries Licenses (REQUIRED) `-- README.md # - Introduces folks how to use this lesson and where they can find more information. s <- sandpaper::get_episodes() sandpaper::set_episodes(order = s, write = TRUE) sandpaper::build_lesson()"},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"contributing-to-a-lesson","dir":"","previous_headings":"Usage","what":"Contributing to a Lesson","title":"The Carpentries Lesson Infrastructure Engine","text":"contribute lesson, can either fork lesson repository clone computer manually GitHub, can use {usethis} package automate . example, can create copy Programming R computer’s Desktop. copy source files computer move directory. Note rendered website immediately available. download site currently appears web, use: download site rendered markdown files site/ folder. save bandwidth, can choose just download markdown files artifacts settin site = FALSE. Now, can edit Rmarkdown files episodes/ quickly render site. upload changes lesson repository, can use follow","code":"usethis::create_from_github( repo = \"swcarpentry/r-novice-gapminder\", destdir = \"~/Desktop/r-novice-gampinder\", fork = TRUE ) sandpaper::fetch_lesson(markdown = TRUE, site = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"maintaining-a-lesson","dir":"","previous_headings":"Usage","what":"Maintaining a Lesson","title":"The Carpentries Lesson Infrastructure Engine","text":"maintaining lesson, high likelihood already copy machine. , follow instructions contributing lesson section . typical workflow look like : open sandpaper project RStudio make edits files episodes/ folder R console run following","code":"sandpaper::check_lesson() # validates the structure of the input files sandpaper::build_lesson() # builds and validates lesson"},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"rendering-a-portable-site","dir":"","previous_headings":"Usage","what":"Rendering a portable site","title":"The Carpentries Lesson Infrastructure Engine","text":"render portable site, can follow instructions contributing lesson maintaining lesson set . lesson set , can use following command: render fully portable lesson site zip file site/ folder. can distribute lesson learners reliable internet access use offline without sacrificing styling.","code":"sandpaper::build_portable_lesson(version = \"current\")"},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"rendering-with-github-actions","dir":"","previous_headings":"Usage","what":"Rendering with GitHub actions","title":"The Carpentries Lesson Infrastructure Engine","text":"Ultimately, minimal number functions handle situation writing CI configuration files maddening. straightforward function : function create git worktrees orphan md-outputs branch site/built folder orphan gh-pages branch site/docs folder. , generate site normal. css js libraries may need updating lesson material , step can created just rebuilding site uses: lesson given release, current site folder needs duplicated versioned folder tag needs added md-outputs branch:","code":"sandpaper::ci_deploy(md_branch = \"md-outputs\", site_branch = \"gh-pages\") sandpaper::ci_build_site(branch = \"gh-pages\") sandpaper::ci_release(tag = \"0.1\", md_branch = \"md-outputs\", site_branch = \"gh-pages\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_404.html","id":null,"dir":"Reference","previous_headings":"","what":"Build the 404 page for a lesson — build_404","title":"Build the 404 page for a lesson — build_404","text":"Build 404 page lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_404.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build the 404 page for a lesson — build_404","text":"","code":"build_404(pkg, quiet = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_404.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build the 404 page for a lesson — build_404","text":"pkg list object generated pkgdown::as_pkgdown() quiet passed build_html(). FALSE (default), message printed screen build progress. TRUE, messages generated.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_404.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build the 404 page for a lesson — build_404","text":"TRUE page successfully generated","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_404.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build the 404 page for a lesson — build_404","text":"lesson build process, 404 page absolute links back source pages must generated otherwise, subsequent attempts escape 404 page futile. function intended run lesson website already built called side-effect creating 404 page.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_agg.html","id":null,"dir":"Reference","previous_headings":"","what":"Build a page for aggregating common elements — build_aio","title":"Build a page for aggregating common elements — build_aio","text":"Build page aggregating common elements","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_agg.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build a page for aggregating common elements — build_aio","text":"","code":"build_aio(pkg, pages = NULL, quiet = FALSE) build_images(pkg, pages = NULL, quiet = FALSE) build_instructor_notes(pkg, pages = NULL, built = NULL, quiet) build_keypoints(pkg, pages = NULL, quiet = FALSE) build_agg_page( pkg, pages, title = NULL, slug = NULL, aggregate = \"section\", append = \"self::node()\", prefix = FALSE, quiet = FALSE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_agg.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build a page for aggregating common elements — build_aio","text":"pkg object created via pkgdown::as_pkgdown() lesson. pages output function read_all_html(): nested list xml_document objects representing episodes lesson quiet TRUE, messages emitted. FALSE, pkgdown report creation temporary file. built vector markdown documents recently rebuilt (future use) title new page title slug slug page (e.g. \"aio\" become \"aio.html\") aggregate selector lesson content want aggregate. default \"section\", aggregate sections, nothing outside sections. grab everything page, use \"*\" append selector section page aggregate data placed. defaults \"self::node()\", indicates entire page appended. prefix flag add prefix aggregated sections. Defaults FALSE.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_agg.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build a page for aggregating common elements — build_aio","text":"NULL, invisibly. called side-effect","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_agg.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build a page for aggregating common elements — build_aio","text":"Building aggregate page much akin copy/paste—take elements across several pages paste one large page. can programmatically using XPath extract nodes pages add document. customise page, need things: title slug method prepare insert extracted content (e.g. make_aio_section())","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_agg.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Build a page for aggregating common elements — build_aio","text":"function assumes already built episodes lesson.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_agg.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build a page for aggregating common elements — build_aio","text":"","code":"if (FALSE) { # build_aio() assumes that your lesson has been built and takes in a # pkgdown object, which can be created from the `site/` folder in your # lesson. lsn <- \"/path/to/my/lesson\" pkg <- pkgdown::as_pkgdown(fs::path(lsn, \"site\")) htmls <- read_all_html(pkg$dst_path) build_aio(pkg, htmls, quiet = FALSE) build_keypoints(pkg, htmls, quiet = FALSE) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_html.html","id":null,"dir":"Reference","previous_headings":"","what":"Build a single episode html file — build_episode_html","title":"Build a single episode html file — build_episode_html","text":"Carpentries-specific wrapper around pkgdown::render_page() templates {varnish}. function largely internal use likely change.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_html.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build a single episode html file — build_episode_html","text":"","code":"build_episode_html( path_md, path_src = NULL, page_back = \"index.md\", page_forward = \"index.md\", pkg, quiet = FALSE, page_progress = NULL, sidebar = NULL, date = NULL )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_html.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build a single episode html file — build_episode_html","text":"path_md path episode markdown (RMarkdown) file (usually via build_episode_md()). path_src default NULL indicating source file determined sandpaper-source entry yaml header. present, option allows specify file. page_back URL previous page page_forward URL next page pkg pkgdown object containing metadata site quiet TRUE, messages produced. Defaults TRUE. page_progress integer 0 100 indicating rounded percent page progress. Defaults NULL. sidebar character vector links episodes use sidebar. current episode replaced index chapters episode. date date episode last built.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_html.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build a single episode html file — build_episode_html","text":"TRUE page successful, FALSE otherwise.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_html.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Build a single episode html file — build_episode_html","text":"function internal use, exported know .","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_html.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build a single episode html file — build_episode_html","text":"","code":"if (FALSE) { # 2022-04-15: this suddenly started throwing a check error # that says \"connections left open: (file) and I can't figure out where the # hell its coming from, so I'm just going to not run this :( if (.Platform$OS.type == \"windows\") { options(\"sandpaper.use_renv\" = FALSE) } if (!interactive() && getOption(\"sandpaper.use_renv\")) { old <- renv::config$cache.symlinks() options(renv.config.cache.symlinks = FALSE) on.exit(options(renv.config.cache.symlinks = old), add = TRUE) } tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = TRUE) suppressMessages(set_episodes(tmp, get_episodes(tmp), write = TRUE)) if (rmarkdown::pandoc_available(\"2.11\")) { # we can only build this if we have pandoc build_lesson(tmp) } # create a new file in files fun_file <- file.path(tmp, \"episodes\", \"files\", \"fun.Rmd\") txt <- c( \"---\\ntitle: Fun times\\n---\\n\\n\", \"# new page\\n\", \"This is coming from `r R.version.string`\\n\", \"::: testimonial\\n\\n#### testimony!\\n\\nwhat\\n:::\\n\" ) file.create(fun_file) on.exit(unlink(tmp, recursive = TRUE, force = TRUE)) writeLines(txt, fun_file) hash <- tools::md5sum(fun_file) res <- build_episode_md(fun_file, hash) if (rmarkdown::pandoc_available(\"2.11\")) { # we need to set the global values sandpaper:::set_globals(res) on.exit(clear_globals(), add = TRUE) # we can only build this if we have pandoc build_episode_html(res, path_src = fun_file, pkg = pkgdown::as_pkgdown(file.path(tmp, \"site\")) ) } }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_md.html","id":null,"dir":"Reference","previous_headings":"","what":"Build an episode to markdown — build_episode_md","title":"Build an episode to markdown — build_episode_md","text":"uses knitr::knit() custom options set Carpentries template. runs separate process avoid issues user-specific options bleeding .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_md.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build an episode to markdown — build_episode_md","text":"","code":"build_episode_md( path, hash = NULL, outdir = path_built(path), workdir = path_built(path), workenv = globalenv(), profile = \"lesson-requirements\", quiet = FALSE, error = TRUE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_md.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build an episode to markdown — build_episode_md","text":"path path RMarkdown file hash hash prepend output. parameter deprecated effectively useless. outdir directory write workdir directory episode rendered workenv environment use evaluation. Defaults global environment, evaluates environment callr::r(). quiet TRUE, output suppressed, default FALSE show {knitr} output. error TRUE (default) errors make invalid build. can set false cause build fail error occurs. generally controlled via fail_on_error config option.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_md.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build an episode to markdown — build_episode_md","text":"path output, invisibly","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_md.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Build an episode to markdown — build_episode_md","text":"function internal use, exported know .","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_md.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build an episode to markdown — build_episode_md","text":"","code":"if (.Platform$OS.type == \"windows\") { options(\"sandpaper.use_renv\" = FALSE) } if (!interactive() && getOption(\"sandpaper.use_renv\")) { old <- renv::config$cache.symlinks() options(renv.config.cache.symlinks = FALSE) on.exit(options(renv.config.cache.symlinks = old), add = TRUE) } fun_dir <- tempfile() dir.create(fs::path(fun_dir, \"episodes\"), recursive = TRUE) fun_file <- file.path(fun_dir, \"episodes\", \"fun.Rmd\") file.create(fun_file) #> [1] TRUE txt <- c( \"---\\ntitle: Fun times\\n---\\n\\n\", \"# new page\\n\", \"This is coming from `r R.version.string`\" ) writeLines(txt, fun_file) res <- build_episode_md(fun_file, outdir = fun_dir, workdir = fun_dir) #> #> #> processing file: /tmp/RtmpD6AhNE/file16eff69d5d4/episodes/fun.Rmd #> 1/1 #> output file: /tmp/RtmpD6AhNE/file16eff69d5d4/fun.md #> #>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_handout.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a code handout of challenges without solutions — build_handout","title":"Create a code handout of challenges without solutions — build_handout","text":"function build handout save files/code-handout.R lesson website. build website enable options(sandpaper.handout = TRUE) want specify path, can use options(sandpaper.handout = \"/path//handout.R\") save handout specific path.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_handout.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a code handout of challenges without solutions — build_handout","text":"","code":"build_handout(path = \".\", out = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_handout.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a code handout of challenges without solutions — build_handout","text":"path path lesson. Defaults current working directory path handout document. NULL (default) TRUE, output site/built/files/code-handout.R.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_home.html","id":null,"dir":"Reference","previous_headings":"","what":"Build a home page for a lesson — build_home","title":"Build a home page for a lesson — build_home","text":"Build home page lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_home.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build a home page for a lesson — build_home","text":"","code":"build_home(pkg, quiet, next_page = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_home.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build a home page for a lesson — build_home","text":"pkg list generated pkgdown::as_pkgdown() site/ folder lesson. quiet boolean passed build_html(). TRUE, pkgdown report files built next_page next page file name. allow navigation element set correctly navigation bar","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_home.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build a home page for a lesson — build_home","text":"nothing. used side-effect","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_home.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build a home page for a lesson — build_home","text":"index page lesson combination two pages: index.md (README index exist) learners/setup.md function uses render_html() convert page HTML, gets passed \"syllabus\" \"overview\" templates {varnish} (via build_html() function {{{ readme }}} {{{ setup }}} keys.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_html.html","id":null,"dir":"Reference","previous_headings":"","what":"Build instructor and learner HTML page — build_html","title":"Build instructor and learner HTML page — build_html","text":"Build instructor learner HTML page","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_html.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build instructor and learner HTML page — build_html","text":"","code":"build_html( template = \"chapter\", pkg, nodes, global_data, path_md, quiet = TRUE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_html.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build instructor and learner HTML page — build_html","text":"template name {varnish} template use. Defaults \"chapter\" pkg object created pkgdown::as_pkgdown() nodes xml_document object. nodes list two xml_documents; one instructors one learners instructors schedule available . instructor learner page, single xml_document object. global_data list store object contains copies global variables page, including metadata, navigation, variables {varnish} templates. path_md path (absolute, relative, filename) current markdown file processed. quiet parameter passed pkgdown::render_page() print progress TRUE (default).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_html.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build instructor and learner HTML page — build_html","text":"TRUE page built NULL need rebuilt","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_html.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build instructor and learner HTML page — build_html","text":"function central workhorse connects global lesson metadata global variables page rendering engine: {pkgdown}. perform global operations includes setting navigation (via update_sidebar()), adding metadata, building instructor learner versions page (via pkgdown::render_page()). Workbench, three types pages: primary content pages: primary content 1:1 relationship source output. episodes along custom learner instructor content aggregate content pages: pages aggregated pages key points, --one, images concatenated content pages: concatenations source files potentially aggregate data. Examples index, learner profiles, instructor notes pages. types pages process setting content, gets processed passed .","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_lesson.html","id":null,"dir":"Reference","previous_headings":"","what":"Build your lesson site — build_lesson","title":"Build your lesson site — build_lesson","text":"function orchestrates rendering generated lesson content applying theme HTML site.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_lesson.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build your lesson site — build_lesson","text":"","code":"build_lesson( path = \".\", rebuild = FALSE, quiet = !interactive(), preview = TRUE, override = list() )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_lesson.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build your lesson site — build_lesson","text":"path path repository (defaults current working directory) rebuild TRUE, everything built scratch cache. Defaults FALSE, build markdown files built . quiet TRUE, output supressed preview TRUE, rendered website opened new window override options override (e.g. building alternative paths). used internally likely changed.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_lesson.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build your lesson site — build_lesson","text":"TRUE successful, character vector issues unsuccessful.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_lesson.html","id":"structure-of-a-workbench-lesson","dir":"Reference","previous_headings":"","what":"Structure of a Workbench Lesson","title":"Build your lesson site — build_lesson","text":"Carpentries Workbench lesson comprised set markdown files folders:","code":"+-- config.yaml +-- index.md +-- episodes | +-- data | +-- fig | +-- files | \\-- introduction.Rmd +-- instructors | \\-- instructor-notes.md +-- learners | \\-- setup.md +-- profiles | \\-- learner-profiles.md +-- links.md +-- site \\-- [...] +-- renv | \\-- [...] +-- CODE_OF_CONDUCT.md +-- CONTRIBUTING.md +-- LICENSE.md \\-- README.md"},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_lesson.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build your lesson site — build_lesson","text":"","code":"tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4ebb7851... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4ebb7851... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4ebb7851... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4ebb7851... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4ebb7851... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef4ebb7851/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4ebb7851... #> ✔ First episode created in /tmp/RtmpD6AhNE/file16ef4ebb7851/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4ebb7851... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4ebb7851... #> ✔ Lesson successfully created in /tmp/RtmpD6AhNE/file16ef4ebb7851 #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4ebb7851... #> /tmp/RtmpD6AhNE/file16ef4ebb7851 create_episode(\"first-script\", path = tmp, open = FALSE) #> ☐ Edit /tmp/RtmpD6AhNE/file16ef4ebb7851/episodes/first-script.Rmd. #> /tmp/RtmpD6AhNE/file16ef4ebb7851/episodes/first-script.Rmd check_lesson(tmp) build_lesson(tmp) #> ── Initialising site ─────────────────────────────────────────────────── #> Copying <pkgdown>/BS3/assets/bootstrap-toc.css to bootstrap-toc.css #> Copying <pkgdown>/BS3/assets/bootstrap-toc.js to bootstrap-toc.js #> Copying <pkgdown>/BS3/assets/docsearch.css to docsearch.css #> Copying <pkgdown>/BS3/assets/docsearch.js to docsearch.js #> Copying <pkgdown>/BS3/assets/link.svg to link.svg #> Copying <pkgdown>/BS3/assets/pkgdown.css to pkgdown.css #> Copying <pkgdown>/BS3/assets/pkgdown.js to pkgdown.js #> Copying <varnish>/pkgdown/assets/android-chrome-192x192.png to #> android-chrome-192x192.png #> Copying <varnish>/pkgdown/assets/android-chrome-512x512.png to #> android-chrome-512x512.png #> Copying <varnish>/pkgdown/assets/apple-touch-icon.png to #> apple-touch-icon.png #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.ttf to #> assets/fonts/Mulish-Bold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.woff to #> assets/fonts/Mulish-Bold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.ttf to #> assets/fonts/Mulish-ExtraBold.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.eot to #> assets/fonts/mulish-v5-latin-regular.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.svg to #> assets/fonts/mulish-v5-latin-regular.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.ttf to #> assets/fonts/mulish-v5-latin-regular.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff to #> assets/fonts/mulish-v5-latin-regular.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff2 to #> assets/fonts/mulish-v5-latin-regular.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff to #> assets/fonts/mulish-variablefont_wght.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff2 to #> assets/fonts/mulish-variablefont_wght.woff2 #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo-sm.svg #> to assets/images/carpentries-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo.svg to #> assets/images/carpentries-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo-sm.svg to #> assets/images/data-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo.svg to #> assets/images/data-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/dropdown-arrow.svg to #> assets/images/dropdown-arrow.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo-sm.svg to #> assets/images/incubator-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo.svg to #> assets/images/incubator-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo-sm.svg to #> assets/images/lab-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo.svg to #> assets/images/lab-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo-sm.svg to #> assets/images/library-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo.svg to #> assets/images/library-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/minus.svg to #> assets/images/minus.svg #> Copying <varnish>/pkgdown/assets/assets/images/plus.svg to #> assets/images/plus.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo-sm.svg to #> assets/images/software-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo.svg to #> assets/images/software-logo.svg #> Copying <varnish>/pkgdown/assets/assets/scripts.js to assets/scripts.js #> Copying <varnish>/pkgdown/assets/assets/styles.css to assets/styles.css #> Copying <varnish>/pkgdown/assets/assets/styles.css.map to #> assets/styles.css.map #> Copying <varnish>/pkgdown/assets/assets/themetoggle.js to #> assets/themetoggle.js #> Copying <varnish>/pkgdown/assets/favicon-16x16.png to favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicon-32x32.png to favicon-32x32.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-114x114.png to #> favicons/cp/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-120x120.png to #> favicons/cp/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-144x144.png to #> favicons/cp/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-152x152.png to #> favicons/cp/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-57x57.png #> to favicons/cp/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-60x60.png #> to favicons/cp/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-72x72.png #> to favicons/cp/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-76x76.png #> to favicons/cp/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-128.png to #> favicons/cp/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-16x16.png to #> favicons/cp/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-196x196.png to #> favicons/cp/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-32x32.png to #> favicons/cp/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-96x96.png to #> favicons/cp/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon.ico to #> favicons/cp/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-144x144.png to #> favicons/cp/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-150x150.png to #> favicons/cp/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x150.png to #> favicons/cp/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x310.png to #> favicons/cp/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-70x70.png to #> favicons/cp/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-114x114.png to #> favicons/dc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-120x120.png to #> favicons/dc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-144x144.png to #> favicons/dc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-152x152.png to #> favicons/dc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-57x57.png #> to favicons/dc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-60x60.png #> to favicons/dc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-72x72.png #> to favicons/dc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-76x76.png #> to favicons/dc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-128.png to #> favicons/dc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-16x16.png to #> favicons/dc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-196x196.png to #> favicons/dc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-32x32.png to #> favicons/dc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-96x96.png to #> favicons/dc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon.ico to #> favicons/dc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-144x144.png to #> favicons/dc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-150x150.png to #> favicons/dc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x150.png to #> favicons/dc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x310.png to #> favicons/dc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-70x70.png to #> favicons/dc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-114x114.png to #> favicons/lc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-120x120.png to #> favicons/lc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-144x144.png to #> favicons/lc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-152x152.png to #> favicons/lc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-57x57.png #> to favicons/lc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-60x60.png #> to favicons/lc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-72x72.png #> to favicons/lc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-76x76.png #> to favicons/lc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-128.png to #> favicons/lc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-16x16.png to #> favicons/lc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-196x196.png to #> favicons/lc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-32x32.png to #> favicons/lc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-96x96.png to #> favicons/lc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon.ico to #> favicons/lc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-144x144.png to #> favicons/lc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-150x150.png to #> favicons/lc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x150.png to #> favicons/lc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x310.png to #> favicons/lc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-70x70.png to #> favicons/lc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-114x114.png to #> favicons/swc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-120x120.png to #> favicons/swc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-144x144.png to #> favicons/swc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-152x152.png to #> favicons/swc/apple-touch-icon-152x152.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-57x57.png to #> favicons/swc/apple-touch-icon-57x57.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-60x60.png to #> favicons/swc/apple-touch-icon-60x60.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-72x72.png to #> favicons/swc/apple-touch-icon-72x72.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-76x76.png to #> favicons/swc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-128.png to #> favicons/swc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-16x16.png to #> favicons/swc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-196x196.png to #> favicons/swc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-32x32.png to #> favicons/swc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-96x96.png to #> favicons/swc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon.ico to #> favicons/swc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-144x144.png to #> favicons/swc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-150x150.png to #> favicons/swc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x150.png to #> favicons/swc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x310.png to #> favicons/swc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-70x70.png to #> favicons/swc/mstile-70x70.png #> Copying <varnish>/pkgdown/assets/mstile-150x150.png to #> mstile-150x150.png #> Copying <varnish>/pkgdown/assets/safari-pinned-tab.svg to #> safari-pinned-tab.svg #> Copying <varnish>/pkgdown/assets/site.webmanifest to site.webmanifest #> ℹ Previewing site"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_markdown.html","id":null,"dir":"Reference","previous_headings":"","what":"Build plain markdown from the RMarkdown episodes — build_markdown","title":"Build plain markdown from the RMarkdown episodes — build_markdown","text":"spirit {hugodown}, function build plain markdown files minimal R package site/ folder {sandpaper} lesson repository tagged hash file ensure files changed rebuilt.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_markdown.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build plain markdown from the RMarkdown episodes — build_markdown","text":"","code":"build_markdown(path = \".\", rebuild = FALSE, quiet = FALSE, slug = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_markdown.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build plain markdown from the RMarkdown episodes — build_markdown","text":"path path repository (defaults current working directory) rebuild TRUE, everything built scratch cache. Defaults FALSE, build markdown files built .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_markdown.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build plain markdown from the RMarkdown episodes — build_markdown","text":"TRUE successful, character vector issues unsuccessful.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Wrapper for site builder — build_site","title":"Wrapper for site builder — build_site","text":"Wrapper site builder","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Wrapper for site builder — build_site","text":"","code":"build_site( path = \".\", quiet = !interactive(), preview = TRUE, override = list(), slug = NULL, built = NULL )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_site.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Wrapper for site builder — build_site","text":"path path repository (defaults current working directory) quiet TRUE, output supressed preview TRUE, rendered website opened new window override options override (e.g. building alternative paths). used internally likely changed. slug slug file preview RStudio. NULL, preview default home page. episode whose slug 01-introduction, setting slug = \"01-introduction\" allow RStudio open preview window right page. built character vector newly built files NULL.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_site.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Wrapper for site builder — build_site","text":"assumes markdown files already built work otherwise","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_status.html","id":null,"dir":"Reference","previous_headings":"","what":"Identify what files need to be rebuilt and what need to be removed — get_hash","title":"Identify what files need to be rebuilt and what need to be removed — get_hash","text":"build_status() takes vector files compares text database files checksums. heavily adapted blogdown provide utilities removal updating old database.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_status.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Identify what files need to be rebuilt and what need to be removed — get_hash","text":"","code":"get_hash(path, db = fs::path(path_built(path), \"md5sum.txt\")) get_built_db(db = \"site/built/md5sum.txt\", filter = \"*R?md\") build_status( sources, db = \"site/built/md5sum.txt\", rebuild = FALSE, write = FALSE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_status.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Identify what files need to be rebuilt and what need to be removed — get_hash","text":"path path least one generated markdown file db path database filter regex describing files include. sources character vector source files single file rebuilt. must absolute paths rebuild files rebuilt, set TRUE (defaults FALSE) write TRUE, database updated, Defaults FALSE, meaning database remain .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_status.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Identify what files need to be rebuilt and what need to be removed — get_hash","text":"list following elements build absolute paths files build new new data frame three columns: file relative path source file checksum md5 sum source file built relative path built file date date file last updated/built remove absolute paths files remove. missing nothing remove old old database (debugging). missing old database single file rebuilt.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_status.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Identify what files need to be rebuilt and what need to be removed — get_hash","text":"get_built_db() returns text database, can filter get_hash() probably named get_expected_hash() return expected hash given file database supply single file function, assume want one file rebuilt, always return file $build element update md5 sum database (changed ). supply multiple files, indicating files care database updated accordingly, removing entries missing sources.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_status.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Identify what files need to be rebuilt and what need to be removed — get_hash","text":"","code":"# This demonstration will show how a temporary database can be set up. It # will only work with a sandpaper lesson # setup ----------------------------------------------------------------- tmp <- tempfile() on.exit(fs::dir_delete(tmp), add = TRUE) #> Error: [ENOENT] Failed to search directory '/tmp/RtmpD6AhNE/file16ef2f6aaacf': no such file or directory create_lesson(tmp, rmd = FALSE, open = FALSE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2f6aaacf... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2f6aaacf... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2f6aaacf... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2f6aaacf... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2f6aaacf... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef2f6aaacf/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2f6aaacf... #> ✔ First episode created in /tmp/RtmpD6AhNE/file16ef2f6aaacf/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2f6aaacf... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2f6aaacf... #> ✔ Lesson successfully created in /tmp/RtmpD6AhNE/file16ef2f6aaacf #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2f6aaacf... #> /tmp/RtmpD6AhNE/file16ef2f6aaacf # show build status ----------------------------------------------------- # get namespace to use internal functions sp <- asNamespace(\"sandpaper\") db <- fs::path(tmp, \"site/built/md5sum.txt\") resources <- fs::path(tmp, c(\"episodes/introduction.md\", \"index.md\")) # first run, everything needs to be built and no build file exists sp$build_status(resources, db, write = TRUE) #> $build #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/episodes/introduction.md #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/index.md #> #> $new #> file #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/episodes/introduction.md episodes/introduction.md #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/index.md index.md #> checksum #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/episodes/introduction.md fd46501f174bb7e6cc280a1436fbc12a #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/episodes/introduction.md site/built/introduction.md #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/index.md site/built/index.md #> date #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/episodes/introduction.md 2024-10-15 #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/index.md 2024-10-15 #> # second run, everything is identical and nothing to be rebuilt sp$build_status(resources, db, write = TRUE) #> $build #> character(0) #> #> $remove #> character(0) #> #> $new #> file checksum #> 1 episodes/introduction.md fd46501f174bb7e6cc280a1436fbc12a #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-10-15 #> 2 site/built/index.md 2024-10-15 #> #> $old #> file checksum #> 1 episodes/introduction.md fd46501f174bb7e6cc280a1436fbc12a #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-10-15 #> 2 site/built/index.md 2024-10-15 #> # this is because the db exists on disk and you can query it sp$get_built_db(db, filter = \"*\") #> file checksum #> 1 episodes/introduction.md fd46501f174bb7e6cc280a1436fbc12a #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-10-15 #> 2 site/built/index.md 2024-10-15 sp$get_built_db(db, filter = \"*R?md\") #> file checksum #> 1 episodes/introduction.md fd46501f174bb7e6cc280a1436fbc12a #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-10-15 #> 2 site/built/index.md 2024-10-15 # if you get the hash of the file, it's equal to the expected: print(actual <- tools::md5sum(resources[[1]])) #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/episodes/introduction.md #> \"fd46501f174bb7e6cc280a1436fbc12a\" print(expected <- sp$get_hash(resources[[1]], db)) #> [1] \"fd46501f174bb7e6cc280a1436fbc12a\" unname(actual == expected) #> [1] TRUE # replaced files need to be rebuilt ------------------------------------- # if we change the introduction to an R Markdown file, the build will # see this as a deleted file and re-added file. cat(\"This is now an R Markdown document and the time is `r Sys.time()`\\n\", file = resources[[1]], append = TRUE) fs::file_move(resources[[1]], fs::path_ext_set(resources[[1]], \"Rmd\")) resources[[1]] <- fs::path_ext_set(resources[[1]], \"Rmd\") set_episodes(tmp, fs::path_file(resources[[1]]), write = TRUE) sp$build_status(resources, db, write = TRUE) #> $build #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/episodes/introduction.Rmd #> #> $remove #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/site/built/introduction.md #> #> $new #> file checksum #> 2 episodes/introduction.Rmd 42f28ae9ac714f87eb912bfccf614cab #> 1 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 2 site/built/introduction.md 2024-10-15 #> 1 site/built/index.md 2024-10-15 #> #> $old #> file checksum #> 1 episodes/introduction.md fd46501f174bb7e6cc280a1436fbc12a #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-10-15 #> 2 site/built/index.md 2024-10-15 #> # modified files need to be rebuilt ------------------------------------- cat(\"We are using `r R.version.string`\\n\", file = resources[[1]], append = TRUE) sp$build_status(resources, db, write = TRUE) #> $build #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/episodes/introduction.Rmd #> #> $remove #> character(0) #> #> $new #> file checksum #> 1 episodes/introduction.Rmd 700f007bdd7e8fd6e3f7011f80dacf7b #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-10-15 #> 2 site/built/index.md 2024-10-15 #> #> $old #> file checksum #> 1 episodes/introduction.Rmd 42f28ae9ac714f87eb912bfccf614cab #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-10-15 #> 2 site/built/index.md 2024-10-15 #> # child files require rebuilding ---------------------------------------- writeLines(\"Hello from another file!\\n\", fs::path(tmp, \"episodes\", \"files\", \"hi.md\")) cat(\"\\n\\n```{r child='files/hi.md'}\\n```\\n\", file = resources[[1]], append = TRUE) sp$build_status(resources, db, write = TRUE) #> $build #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/episodes/introduction.Rmd #> #> $remove #> character(0) #> #> $new #> file checksum #> 1 episodes/introduction.Rmd 4a0b39645c21579d9992ad3b50d623e4 #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-10-15 #> 2 site/built/index.md 2024-10-15 #> #> $old #> file checksum #> 1 episodes/introduction.Rmd 700f007bdd7e8fd6e3f7011f80dacf7b #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-10-15 #> 2 site/built/index.md 2024-10-15 #> # NOTE: for child files, the checksums are the checksum of the checksums # of the parent and children, so the file checksum may not make sense # changing a child file rebuilds the parent ---------------------------- cat(\"Goodbye!\\n\", append = TRUE, file = fs::path(tmp, \"episodes\", \"files\", \"hi.md\")) sp$build_status(resources, db, write = TRUE) #> $build #> /tmp/RtmpD6AhNE/file16ef2f6aaacf/episodes/introduction.Rmd #> #> $remove #> character(0) #> #> $new #> file checksum #> 1 episodes/introduction.Rmd 2ab510dfa3fbd1f224ab3c20547391ea #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-10-15 #> 2 site/built/index.md 2024-10-15 #> #> $old #> file checksum #> 1 episodes/introduction.Rmd 4a0b39645c21579d9992ad3b50d623e4 #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-10-15 #> 2 site/built/index.md 2024-10-15 #>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_lesson.html","id":null,"dir":"Reference","previous_headings":"","what":"deprecated Check the lesson structure for errors — check_lesson","title":"deprecated Check the lesson structure for errors — check_lesson","text":"function now deprecated favour validate_lesson().","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_lesson.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"deprecated Check the lesson structure for errors — check_lesson","text":"","code":"check_lesson(path = \".\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_lesson.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"deprecated Check the lesson structure for errors — check_lesson","text":"path path lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_lesson.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"deprecated Check the lesson structure for errors — check_lesson","text":"TRUE (invisibly) lesson cromulent, otherwise, error list things fix.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_lesson.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"deprecated Check the lesson structure for errors — check_lesson","text":"","code":"# Everything should work out of the box tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4640d938... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4640d938... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4640d938... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4640d938... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4640d938... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef4640d938/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4640d938... #> ✔ First episode created in /tmp/RtmpD6AhNE/file16ef4640d938/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4640d938... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4640d938... #> ✔ Lesson successfully created in /tmp/RtmpD6AhNE/file16ef4640d938 #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4640d938... #> /tmp/RtmpD6AhNE/file16ef4640d938 check_lesson(tmp) # if things do not work, then an error is thrown with information about # what has failed you unlink(file.path(tmp, \".gitignore\")) unlink(file.path(tmp, \"site\"), recursive = TRUE) try(check_lesson(tmp)) #> ! Path '/tmp/RtmpD6AhNE/file16ef4640d938/site' does not exist #> ! The .gitignore file is missing the following elements: #> episodes/*html #> site/* #> !site/README.md #> .Rhistory #> .Rapp.history #> .RData #> .Ruserdata #> *-Ex.R #> /*.tar.gz #> /*.Rcheck/ #> .Rproj.user/ #> vignettes/*.html #> vignettes/*.pdf #> .httr-oauth #> *_cache/ #> /cache/ #> *.utf8.md #> *.knit.md #> .Renviron #> docs/ #> po/*~ #> ! The file 'site/README.md' does not exist #> Error in report_validation(checklist, \"There were errors with the lesson structure.\") : #> There were errors with the lesson structure. unlink(tmp)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_pandoc.html","id":null,"dir":"Reference","previous_headings":"","what":"Check the existence of pandoc — check_pandoc","title":"Check the existence of pandoc — check_pandoc","text":"function adds context rmarkdown::pandoc_available() provides error message directing user download latest version pandoc RStudio Desktop.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_pandoc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check the existence of pandoc — check_pandoc","text":"","code":"check_pandoc(quiet = TRUE, pv = \"2.11\", rv = \"1.4\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_pandoc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check the existence of pandoc — check_pandoc","text":"quiet TRUE, message emitted, otherwise pandoc version path sent message (stderr) screen. pv minimum pandoc version rv minimum rstudio version (available)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_pandoc.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check the existence of pandoc — check_pandoc","text":"","code":"# NOTE: this is an internal function, so there is no guarantee that the usage # will remain the same across time. This is merely for demonstration purposes # only. # Check for pandoc ---------------------- asNamespace(\"sandpaper\")$check_pandoc(quiet = FALSE) #> ◉ pandoc found #> version : 3.1.11 #> path : /opt/hostedtoolcache/pandoc/3.1.11/x64 # Message emitted when pandoc cannot be found -------- try(asNamespace(\"sandpaper\")$check_pandoc(quiet = FALSE, pv = \"999\")) #> sandpaper requires pandoc version 999 or higher. #> ! You have pandoc version 3.1.11 in /opt/hostedtoolcache/pandoc/3.1.11/x64 #> → Please visit <https://pandoc.org/installing.html> to install the latest version. #> Error : Incorrect pandoc version"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":null,"dir":"Reference","previous_headings":"","what":"Build and deploy individual site components to a remote branch — ci_build_markdown","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"internal functions provision deploy lesson components orphan git branches. called ci_deploy(). functions side-effect creating updating orphan branches remote repository. assumed access remote.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"","code":"ci_build_markdown( path = \".\", branch = \"md-outputs\", remote = \"origin\", reset = FALSE ) ci_build_site( path = \".\", branch = \"gh-pages\", md = \"md-outputs\", remote = \"origin\", reset = FALSE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"path path lesson branch branch name containing output: ci_build_markdown(): defaults md-output, corresponds md_branch ci_deploy() ci_build_site(): defaults gh-pages, corresponds site_branch ci_deploy() remote name git remote deploy. reset TRUE, markdown cache cleared rebuilding, defaults FALSE meaning markdown cache provisioned used. md branch name contains markdown outputs","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"ci_build_markdown(): expression() evaluated tear worktree created. ci_build_site(): nothing, used side-effect.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"place two functions used within ci_deploy(), de-facto use-case functions, thus, page examples. functions general process: provision git worktree appropriate folder git_worktree_setup() build requisite content folder commit push contents worktree github_worktree_commit() caveats two functions listed sections .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":"ci-build-markdown-","dir":"Reference","previous_headings":"","what":"ci_build_markdown()","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"clean default. must save output object run eval(obj) run clean process. place ci_build_site() can use worktree markdown outputs order build site.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":"ci-build-site-","dir":"Reference","previous_headings":"","what":"ci_build_site()","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"addition steps listed , function needs verify materials necessary build HTML site. first checks presence site/built/. folder can generated ci_build_markdown() build_markdown(). folder exist empty, function attempt fetch folder branch md. everything built pushed, function additionally destroy work tree.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"ci_build_markdown() set sandpaper.use_renv option TRUE, means always use {renv} package cache lesson uses R Markdown.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":null,"dir":"Reference","previous_headings":"","what":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"platform-agnostic method deploying lesson website cached content. function takes advantage git worktrees render push content orphan branches, can used host lesson website. function assumes git clone remote write access remote.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"","code":"ci_deploy( path = \".\", md_branch = \"md-outputs\", site_branch = \"gh-pages\", remote = \"origin\", reset = FALSE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"path path lesson md_branch branch name contains markdown outputs site_branch branch name contains full HTML site remote name git remote deploy. reset TRUE, markdown cache cleared rebuilding, defaults FALSE meaning markdown cache provisioned used.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"Nothing, invisibly. used side-effect","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"ci_deploy() thing build_lesson(), except instead storing outputs site/ folder, pushes outputs remote orphan branches (determined md_branch site_branch arguments). branches used cache website, respectively. branches exist, created.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"requirements","dir":"Reference","previous_headings":"","what":"Requirements","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"function can run non-interactive fashion. try run interactively, get error message. assumes following true: running script automated workflow running clone git repository remote exists writable Unexpected consequences can arise violating assumptions.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"workflow","dir":"Reference","previous_headings":"","what":"Workflow","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"function similar two-step workflow build_lesson(), extra steps ensure git branches set correctly. steps elements common build_lesson() annotated * check git user email registered * Validate lesson generate global variables validate_lesson() provision, build, deploy markdown branch ci_build_markdown() . provision markdown branch git_worktree_setup() ii. * build markdown source documents build_markdown() iii. commit push git worktree remote branch github_worktree_commit() provision, build, deploy site branch ci_build_site() . provision site branch git_worktree_setup() ii. * build site HTML documents build_site() iii. commit push git worktree remote branch github_worktree_commit() iv. remove git worktree github_worktree_remove() remove markdown git worktree github_worktree_remove()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"function interactive use. requires git installed machine destroy anything site/ folder. R-based lessons rebuild components lockfile changed.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"","code":"# For this example, we are setting up a temporary repository with a local # remote called `sandpaper-local`. This demonstrates how `ci_deploy()` # modifies the remote, but there are setup and teardown steps to run. # The actual example is highlighted below under the DEPLOY comment. # SETUP ------------------------------------------------------------------- snd <- asNamespace(\"sandpaper\") tik <- Sys.time() cli::cli_h1(\"Set up\") #> #> ── Set up ────────────────────────────────────────────────────────────── cli::cli_h2(\"Create Lesson\") #> #> ── Create Lesson ── #> restore_fixture <- snd$create_test_lesson() #> → Bootstrapping example lesson #> ℹ Lesson bootstrapped in 3.069285 secs #> → Bootstrapping example lesson res <- getOption(\"sandpaper.test_fixture\") cli::cli_h2(\"Create Remote\") #> #> ── Create Remote ── #> rmt <- fs::file_temp(pattern = \"REMOTE-\") snd$setup_local_remote(repo = res, remote = rmt, verbose = FALSE) #> ℹ Remote set up in 0.01391983 secs tok <- Sys.time() cli::cli_alert_info(\"Elapsed time: {round(tok - tik, 2)} seconds\") #> ℹ Elapsed time: 3.11 seconds # reporting ----- # The repository should only have one branch and the remote should be in # sync with the local. cli::cli_h2(\"Local status\") #> #> ── Local status ── #> gert::git_branch_list(repo = res)[c('name', 'commit', 'updated')] #> # A tibble: 2 × 3 #> name commit updated #> <chr> <chr> <dttm> #> 1 main c46bee47d4c4bebb21013873cd03… 2024-10-15 13:30:00 #> 2 sandpaper-local/main c46bee47d4c4bebb21013873cd03… 2024-10-15 13:30:00 cli::cli_h2(\"First episode status\") #> ── First episode status ── #> gert::git_stat_files(\"episodes/introduction.Rmd\", repo = res) #> # A tibble: 1 × 5 #> file created modified commits head #> * <chr> <dttm> <dttm> <int> <chr> #> 1 episodes/introd… 2024-10-15 13:30:00 2024-10-15 13:30:00 1 c46b… gert::git_stat_files(\"episodes/introduction.Rmd\", repo = rmt) #> # A tibble: 1 × 5 #> file created modified commits head #> * <chr> <dttm> <dttm> <int> <chr> #> 1 episodes/introd… 2024-10-15 13:30:00 2024-10-15 13:30:00 1 c46b… # DEPLOY ------------------------------------------------------------------ tik <- Sys.time() cli::cli_h1(\"deploy to remote\") #> ── deploy to remote ──────────────────────────────────────────────────── sandpaper:::ci_deploy(path = res, remote = \"sandpaper-local\") #> ── Validating Fenced Divs ────────────────────────────────────────────── #> ── Validating Internal Links and Images ──────────────────────────────── #> ::group::Create New Branch #> Running git checkout --orphan md-outputs #> Switched to a new branch 'md-outputs' #> Running git rm -rf --quiet . #> Running git commit --allow-empty -m 'Initializing md-outputs branch' #> [md-outputs (root-commit) f189a1b] Initializing md-outputs branch #> Running git push sandpaper-local 'HEAD:md-outputs' #> To /tmp/RtmpD6AhNE/REMOTE-16ef35725b93 #> * [new branch] HEAD -> md-outputs #> Running git checkout main #> Switched to branch 'main' #> Your branch is up to date with 'sandpaper-local/main'. #> ::endgroup:: #> ::group::Fetch sandpaper-local/md-outputs #> Running git remote set-branches sandpaper-local md-outputs #> Running git fetch sandpaper-local md-outputs #> From /tmp/RtmpD6AhNE/REMOTE-16ef35725b93 #> * branch md-outputs -> FETCH_HEAD #> Running git remote set-branches sandpaper-local '*' #> ::endgroup:: #> ::group::Add worktree for sandpaper-local/md-outputs in site/built #> Running git worktree add --track -B md-outputs \\ #> /tmp/RtmpD6AhNE/file16ef4b5bd42c/lesson-example/site/built \\ #> sandpaper-local/md-outputs #> Preparing worktree (resetting branch 'md-outputs'; was at f189a1b) #> branch 'md-outputs' set up to track 'sandpaper-local/md-outputs'. #> HEAD is now at f189a1b Initializing md-outputs branch #> ::endgroup:: #> ::group::Build Markdown Sources #> ℹ Consent to use package cache provided #> → Searching for and installing available dependencies #> Finding R package dependencies ... Done! #> → Restoring any dependency versions #> - The library is already synchronized with the lockfile. #> → Recording changes in lockfile #> - The lockfile is already up to date. #> ℹ Using package cache in /home/runner/.cache/R/renv #> #> #> processing file: /tmp/RtmpD6AhNE/file16ef4b5bd42c/lesson-example/episodes/introduction.Rmd #> 1/3 #> 2/3 [pyramid] #> 3/3 #> output file: /tmp/RtmpD6AhNE/file16ef4b5bd42c/lesson-example/site/built/introduction.md #> #> ::endgroup:: #> ::group::Commit Markdown Sources #> Running git commit --allow-empty -m \\ #> 'markdown source builds #> #> Auto-generated via `{sandpaper}` #> Source : c46bee47d4c4bebb21013873cd03378db5d0efae #> Branch : main #> Author : carpenter <team@carpentries.org> #> Time : 2024-10-15 13:30:00 +0000 #> Message : Initial commit [via `{sandpaper}`] #> ' #> [md-outputs 0d026c3] markdown source builds #> 13 files changed, 737 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 #> Running git remote -v #> sandpaper-local\t/tmp/RtmpD6AhNE/REMOTE-16ef35725b93 (fetch) #> sandpaper-local\t/tmp/RtmpD6AhNE/REMOTE-16ef35725b93 (push) #> Running git push --force sandpaper-local 'HEAD:md-outputs' #> To /tmp/RtmpD6AhNE/REMOTE-16ef35725b93 #> f189a1b..0d026c3 HEAD -> md-outputs #> ::endgroup:: #> ::group::Create New Branch #> Running git checkout --orphan gh-pages #> Switched to a new branch 'gh-pages' #> Running git rm -rf --quiet . #> Running git commit --allow-empty -m 'Initializing gh-pages branch' #> [gh-pages (root-commit) 74754e5] Initializing gh-pages branch #> Running git push sandpaper-local 'HEAD:gh-pages' #> To /tmp/RtmpD6AhNE/REMOTE-16ef35725b93 #> * [new branch] HEAD -> gh-pages #> Running git checkout main #> Switched to branch 'main' #> Your branch is up to date with 'sandpaper-local/main'. #> ::endgroup:: #> ::group::Fetch sandpaper-local/gh-pages #> Running git remote set-branches sandpaper-local gh-pages #> Running git fetch sandpaper-local gh-pages #> From /tmp/RtmpD6AhNE/REMOTE-16ef35725b93 #> * branch gh-pages -> FETCH_HEAD #> Running git remote set-branches sandpaper-local '*' #> ::endgroup:: #> ::group::Add worktree for sandpaper-local/gh-pages in site/docs #> Running git worktree add --track -B gh-pages \\ #> /tmp/RtmpD6AhNE/file16ef4b5bd42c/lesson-example/site/docs \\ #> sandpaper-local/gh-pages #> Preparing worktree (resetting branch 'gh-pages'; was at 74754e5) #> branch 'gh-pages' set up to track 'sandpaper-local/gh-pages'. #> HEAD is now at 74754e5 Initializing gh-pages branch #> ::endgroup:: #> ::group::Build Lesson Website #> ◉ pandoc found #> version : 3.1.11 #> path : /opt/hostedtoolcache/pandoc/3.1.11/x64 #> ── Initialising site ─────────────────────────────────────────────────── #> Copying <pkgdown>/BS3/assets/bootstrap-toc.css to bootstrap-toc.css #> Copying <pkgdown>/BS3/assets/bootstrap-toc.js to bootstrap-toc.js #> Copying <pkgdown>/BS3/assets/docsearch.css to docsearch.css #> Copying <pkgdown>/BS3/assets/docsearch.js to docsearch.js #> Copying <pkgdown>/BS3/assets/link.svg to link.svg #> Copying <pkgdown>/BS3/assets/pkgdown.css to pkgdown.css #> Copying <pkgdown>/BS3/assets/pkgdown.js to pkgdown.js #> Copying <varnish>/pkgdown/assets/android-chrome-192x192.png to #> android-chrome-192x192.png #> Copying <varnish>/pkgdown/assets/android-chrome-512x512.png to #> android-chrome-512x512.png #> Copying <varnish>/pkgdown/assets/apple-touch-icon.png to #> apple-touch-icon.png #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.ttf to #> assets/fonts/Mulish-Bold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.woff to #> assets/fonts/Mulish-Bold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.ttf to #> assets/fonts/Mulish-ExtraBold.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.eot to #> assets/fonts/mulish-v5-latin-regular.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.svg to #> assets/fonts/mulish-v5-latin-regular.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.ttf to #> assets/fonts/mulish-v5-latin-regular.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff to #> assets/fonts/mulish-v5-latin-regular.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff2 to #> assets/fonts/mulish-v5-latin-regular.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff to #> assets/fonts/mulish-variablefont_wght.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff2 to #> assets/fonts/mulish-variablefont_wght.woff2 #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo-sm.svg #> to assets/images/carpentries-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo.svg to #> assets/images/carpentries-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo-sm.svg to #> assets/images/data-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo.svg to #> assets/images/data-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/dropdown-arrow.svg to #> assets/images/dropdown-arrow.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo-sm.svg to #> assets/images/incubator-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo.svg to #> assets/images/incubator-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo-sm.svg to #> assets/images/lab-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo.svg to #> assets/images/lab-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo-sm.svg to #> assets/images/library-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo.svg to #> assets/images/library-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/minus.svg to #> assets/images/minus.svg #> Copying <varnish>/pkgdown/assets/assets/images/plus.svg to #> assets/images/plus.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo-sm.svg to #> assets/images/software-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo.svg to #> assets/images/software-logo.svg #> Copying <varnish>/pkgdown/assets/assets/scripts.js to assets/scripts.js #> Copying <varnish>/pkgdown/assets/assets/styles.css to assets/styles.css #> Copying <varnish>/pkgdown/assets/assets/styles.css.map to #> assets/styles.css.map #> Copying <varnish>/pkgdown/assets/assets/themetoggle.js to #> assets/themetoggle.js #> Copying <varnish>/pkgdown/assets/favicon-16x16.png to favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicon-32x32.png to favicon-32x32.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-114x114.png to #> favicons/cp/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-120x120.png to #> favicons/cp/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-144x144.png to #> favicons/cp/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-152x152.png to #> favicons/cp/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-57x57.png #> to favicons/cp/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-60x60.png #> to favicons/cp/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-72x72.png #> to favicons/cp/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-76x76.png #> to favicons/cp/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-128.png to #> favicons/cp/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-16x16.png to #> favicons/cp/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-196x196.png to #> favicons/cp/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-32x32.png to #> favicons/cp/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-96x96.png to #> favicons/cp/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon.ico to #> favicons/cp/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-144x144.png to #> favicons/cp/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-150x150.png to #> favicons/cp/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x150.png to #> favicons/cp/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x310.png to #> favicons/cp/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-70x70.png to #> favicons/cp/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-114x114.png to #> favicons/dc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-120x120.png to #> favicons/dc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-144x144.png to #> favicons/dc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-152x152.png to #> favicons/dc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-57x57.png #> to favicons/dc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-60x60.png #> to favicons/dc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-72x72.png #> to favicons/dc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-76x76.png #> to favicons/dc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-128.png to #> favicons/dc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-16x16.png to #> favicons/dc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-196x196.png to #> favicons/dc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-32x32.png to #> favicons/dc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-96x96.png to #> favicons/dc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon.ico to #> favicons/dc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-144x144.png to #> favicons/dc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-150x150.png to #> favicons/dc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x150.png to #> favicons/dc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x310.png to #> favicons/dc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-70x70.png to #> favicons/dc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-114x114.png to #> favicons/lc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-120x120.png to #> favicons/lc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-144x144.png to #> favicons/lc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-152x152.png to #> favicons/lc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-57x57.png #> to favicons/lc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-60x60.png #> to favicons/lc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-72x72.png #> to favicons/lc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-76x76.png #> to favicons/lc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-128.png to #> favicons/lc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-16x16.png to #> favicons/lc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-196x196.png to #> favicons/lc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-32x32.png to #> favicons/lc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-96x96.png to #> favicons/lc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon.ico to #> favicons/lc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-144x144.png to #> favicons/lc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-150x150.png to #> favicons/lc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x150.png to #> favicons/lc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x310.png to #> favicons/lc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-70x70.png to #> favicons/lc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-114x114.png to #> favicons/swc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-120x120.png to #> favicons/swc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-144x144.png to #> favicons/swc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-152x152.png to #> favicons/swc/apple-touch-icon-152x152.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-57x57.png to #> favicons/swc/apple-touch-icon-57x57.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-60x60.png to #> favicons/swc/apple-touch-icon-60x60.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-72x72.png to #> favicons/swc/apple-touch-icon-72x72.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-76x76.png to #> favicons/swc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-128.png to #> favicons/swc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-16x16.png to #> favicons/swc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-196x196.png to #> favicons/swc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-32x32.png to #> favicons/swc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-96x96.png to #> favicons/swc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon.ico to #> favicons/swc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-144x144.png to #> favicons/swc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-150x150.png to #> favicons/swc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x150.png to #> favicons/swc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x310.png to #> favicons/swc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-70x70.png to #> favicons/swc/mstile-70x70.png #> Copying <varnish>/pkgdown/assets/mstile-150x150.png to #> mstile-150x150.png #> Copying <varnish>/pkgdown/assets/safari-pinned-tab.svg to #> safari-pinned-tab.svg #> Copying <varnish>/pkgdown/assets/site.webmanifest to site.webmanifest #> ── Scanning episodes to rebuild ──────────────────────────────────────── #> Writing `instructor/CODE_OF_CONDUCT.html` #> Writing `CODE_OF_CONDUCT.html` #> Writing `instructor/LICENSE.html` #> Writing `LICENSE.html` #> Writing `instructor/introduction.html` #> Writing `introduction.html` #> Writing `instructor/reference.html` #> Writing `reference.html` #> ── Creating 404 page ─────────────────────────────────────────────────── #> Writing `instructor/404.html` #> Writing `404.html` #> ── Creating learner profiles ─────────────────────────────────────────── #> Writing `instructor/profiles.html` #> Writing `profiles.html` #> ── Creating homepage ─────────────────────────────────────────────────── #> Writing `instructor/index.html` #> Writing `index.html` #> ── Creating keypoints summary ────────────────────────────────────────── #> Writing 'instructor/key-points.html' #> Writing 'key-points.html' #> ── Creating All-in-one page ──────────────────────────────────────────── #> Writing 'instructor/aio.html' #> Writing 'aio.html' #> ── Creating Images page ──────────────────────────────────────────────── #> Writing 'instructor/images.html' #> Writing 'images.html' #> ── Creating Instructor Notes ─────────────────────────────────────────── #> Writing 'instructor/instructor-notes.html' #> Writing 'instructor-notes.html' #> ── Creating sitemap.xml ──────────────────────────────────────────────── #> #> Output created: /tmp/RtmpD6AhNE/file16ef4b5bd42c/lesson-example/site/docs/index.html #> ::endgroup:: #> ::group::Commit Lesson Website #> Running git commit --allow-empty -m \\ #> 'site deploy #> #> Auto-generated via `{sandpaper}` #> Source : 0d026c3f461965cdf8a91e64c1fc7170b3ecff21 #> Branch : md-outputs #> Author : GitHub Actions <actions@github.com> #> Time : 2024-10-15 13:30:04 +0000 #> Message : markdown source builds #> #> Auto-generated via `{sandpaper}` #> Source : c46bee47d4c4bebb21013873cd03378db5d0efae #> Branch : main #> Author : carpenter <team@carpentries.org> #> Time : 2024-10-15 13:30:00 +0000 #> Message : Initial commit [via `{sandpaper}`] #> ' #> [gh-pages 9a56506] site deploy #> 149 files changed, 11334 insertions(+) #> create mode 100644 .nojekyll #> create mode 100644 404.html #> create mode 100644 CODE_OF_CONDUCT.html #> create mode 100644 LICENSE.html #> create mode 100644 aio.html #> create mode 100644 android-chrome-192x192.png #> create mode 100644 android-chrome-512x512.png #> create mode 100644 apple-touch-icon.png #> create mode 100644 assets/fonts/Mulish-Bold.ttf #> create mode 100644 assets/fonts/Mulish-Bold.woff #> create mode 100644 assets/fonts/Mulish-ExtraBold.ttf #> create mode 100644 assets/fonts/mulish-v5-latin-regular.eot #> create mode 100644 assets/fonts/mulish-v5-latin-regular.svg #> create mode 100644 assets/fonts/mulish-v5-latin-regular.ttf #> create mode 100644 assets/fonts/mulish-v5-latin-regular.woff #> create mode 100644 assets/fonts/mulish-v5-latin-regular.woff2 #> create mode 100644 assets/fonts/mulish-variablefont_wght.woff #> create mode 100644 assets/fonts/mulish-variablefont_wght.woff2 #> create mode 100644 assets/images/carpentries-logo-sm.svg #> create mode 100644 assets/images/carpentries-logo.svg #> create mode 100644 assets/images/data-logo-sm.svg #> create mode 100644 assets/images/data-logo.svg #> create mode 100644 assets/images/dropdown-arrow.svg #> create mode 100644 assets/images/incubator-logo-sm.svg #> create mode 100644 assets/images/incubator-logo.svg #> create mode 100644 assets/images/lab-logo-sm.svg #> create mode 100644 assets/images/lab-logo.svg #> create mode 100644 assets/images/library-logo-sm.svg #> create mode 100644 assets/images/library-logo.svg #> create mode 100644 assets/images/minus.svg #> create mode 100644 assets/images/plus.svg #> create mode 100644 assets/images/software-logo-sm.svg #> create mode 100644 assets/images/software-logo.svg #> create mode 100644 assets/scripts.js #> create mode 100644 assets/styles.css #> create mode 100644 assets/styles.css.map #> create mode 100644 assets/themetoggle.js #> create mode 100644 bootstrap-toc.css #> create mode 100644 bootstrap-toc.js #> create mode 100644 config.yaml #> create mode 100644 docsearch.css #> create mode 100644 docsearch.js #> create mode 100644 favicon-16x16.png #> create mode 100644 favicon-32x32.png #> create mode 100644 favicons/cp/apple-touch-icon-114x114.png #> create mode 100644 favicons/cp/apple-touch-icon-120x120.png #> create mode 100644 favicons/cp/apple-touch-icon-144x144.png #> create mode 100644 favicons/cp/apple-touch-icon-152x152.png #> create mode 100644 favicons/cp/apple-touch-icon-57x57.png #> create mode 100644 favicons/cp/apple-touch-icon-60x60.png #> create mode 100644 favicons/cp/apple-touch-icon-72x72.png #> create mode 100644 favicons/cp/apple-touch-icon-76x76.png #> create mode 100644 favicons/cp/favicon-128.png #> create mode 100644 favicons/cp/favicon-16x16.png #> create mode 100644 favicons/cp/favicon-196x196.png #> create mode 100644 favicons/cp/favicon-32x32.png #> create mode 100644 favicons/cp/favicon-96x96.png #> create mode 100644 favicons/cp/favicon.ico #> create mode 100644 favicons/cp/mstile-144x144.png #> create mode 100644 favicons/cp/mstile-150x150.png #> create mode 100644 favicons/cp/mstile-310x150.png #> create mode 100644 favicons/cp/mstile-310x310.png #> create mode 100644 favicons/cp/mstile-70x70.png #> create mode 100644 favicons/dc/apple-touch-icon-114x114.png #> create mode 100644 favicons/dc/apple-touch-icon-120x120.png #> create mode 100644 favicons/dc/apple-touch-icon-144x144.png #> create mode 100644 favicons/dc/apple-touch-icon-152x152.png #> create mode 100644 favicons/dc/apple-touch-icon-57x57.png #> create mode 100644 favicons/dc/apple-touch-icon-60x60.png #> create mode 100644 favicons/dc/apple-touch-icon-72x72.png #> create mode 100644 favicons/dc/apple-touch-icon-76x76.png #> create mode 100644 favicons/dc/favicon-128.png #> create mode 100644 favicons/dc/favicon-16x16.png #> create mode 100644 favicons/dc/favicon-196x196.png #> create mode 100644 favicons/dc/favicon-32x32.png #> create mode 100644 favicons/dc/favicon-96x96.png #> create mode 100644 favicons/dc/favicon.ico #> create mode 100644 favicons/dc/mstile-144x144.png #> create mode 100644 favicons/dc/mstile-150x150.png #> create mode 100644 favicons/dc/mstile-310x150.png #> create mode 100644 favicons/dc/mstile-310x310.png #> create mode 100644 favicons/dc/mstile-70x70.png #> create mode 100644 favicons/lc/apple-touch-icon-114x114.png #> create mode 100644 favicons/lc/apple-touch-icon-120x120.png #> create mode 100644 favicons/lc/apple-touch-icon-144x144.png #> create mode 100644 favicons/lc/apple-touch-icon-152x152.png #> create mode 100644 favicons/lc/apple-touch-icon-57x57.png #> create mode 100644 favicons/lc/apple-touch-icon-60x60.png #> create mode 100644 favicons/lc/apple-touch-icon-72x72.png #> create mode 100644 favicons/lc/apple-touch-icon-76x76.png #> create mode 100644 favicons/lc/favicon-128.png #> create mode 100644 favicons/lc/favicon-16x16.png #> create mode 100644 favicons/lc/favicon-196x196.png #> create mode 100644 favicons/lc/favicon-32x32.png #> create mode 100644 favicons/lc/favicon-96x96.png #> create mode 100644 favicons/lc/favicon.ico #> create mode 100644 favicons/lc/mstile-144x144.png #> create mode 100644 favicons/lc/mstile-150x150.png #> create mode 100644 favicons/lc/mstile-310x150.png #> create mode 100644 favicons/lc/mstile-310x310.png #> create mode 100644 favicons/lc/mstile-70x70.png #> create mode 100644 favicons/swc/apple-touch-icon-114x114.png #> create mode 100644 favicons/swc/apple-touch-icon-120x120.png #> create mode 100644 favicons/swc/apple-touch-icon-144x144.png #> create mode 100644 favicons/swc/apple-touch-icon-152x152.png #> create mode 100644 favicons/swc/apple-touch-icon-57x57.png #> create mode 100644 favicons/swc/apple-touch-icon-60x60.png #> create mode 100644 favicons/swc/apple-touch-icon-72x72.png #> create mode 100644 favicons/swc/apple-touch-icon-76x76.png #> create mode 100644 favicons/swc/favicon-128.png #> create mode 100644 favicons/swc/favicon-16x16.png #> create mode 100644 favicons/swc/favicon-196x196.png #> create mode 100644 favicons/swc/favicon-32x32.png #> create mode 100644 favicons/swc/favicon-96x96.png #> create mode 100644 favicons/swc/favicon.ico #> create mode 100644 favicons/swc/mstile-144x144.png #> create mode 100644 favicons/swc/mstile-150x150.png #> create mode 100644 favicons/swc/mstile-310x150.png #> create mode 100644 favicons/swc/mstile-310x310.png #> create mode 100644 favicons/swc/mstile-70x70.png #> create mode 100644 fig/introduction-rendered-pyramid-1.png #> create mode 100644 images.html #> create mode 100644 index.html #> create mode 100644 instructor-notes.html #> create mode 100644 instructor/404.html #> create mode 100644 instructor/CODE_OF_CONDUCT.html #> create mode 100644 instructor/LICENSE.html #> create mode 100644 instructor/aio.html #> create mode 100644 instructor/images.html #> create mode 100644 instructor/index.html #> create mode 100644 instructor/instructor-notes.html #> create mode 100644 instructor/introduction.html #> create mode 100644 instructor/key-points.html #> create mode 100644 instructor/profiles.html #> create mode 100644 instructor/reference.html #> create mode 100644 introduction.html #> create mode 100644 key-points.html #> create mode 100644 link.svg #> create mode 100644 md5sum.txt #> create mode 100644 mstile-150x150.png #> create mode 100644 pkgdown.css #> create mode 100644 pkgdown.js #> create mode 100644 pkgdown.yml #> create mode 100644 profiles.html #> create mode 100644 reference.html #> create mode 100644 renv.lock #> create mode 100644 safari-pinned-tab.svg #> create mode 100644 site.webmanifest #> create mode 100644 sitemap.xml #> Running git remote -v #> sandpaper-local\t/tmp/RtmpD6AhNE/REMOTE-16ef35725b93 (fetch) #> sandpaper-local\t/tmp/RtmpD6AhNE/REMOTE-16ef35725b93 (push) #> Running git push --force sandpaper-local 'HEAD:gh-pages' #> To /tmp/RtmpD6AhNE/REMOTE-16ef35725b93 #> 74754e5..9a56506 HEAD -> gh-pages #> ::endgroup:: #> Running git worktree remove --force \\ #> /tmp/RtmpD6AhNE/file16ef4b5bd42c/lesson-example/site/docs #> Running git worktree remove --force \\ #> /tmp/RtmpD6AhNE/file16ef4b5bd42c/lesson-example/site/built tok <- Sys.time() cli::cli_alert_info(\"Elapsed time: {round(tok - tik, 2)} seconds\") #> ℹ Elapsed time: 12 seconds # reporting ----- # The repository and remote should both have three branches cli::cli_h2(\"Local status\") #> #> ── Local status ── #> gert::git_branch_list(repo = res)[c('name', 'commit', 'updated')] #> # A tibble: 6 × 3 #> name commit updated #> <chr> <chr> <dttm> #> 1 gh-pages 9a5650697aa664c2ac7b07… 2024-10-15 13:30:12 #> 2 main c46bee47d4c4bebb210138… 2024-10-15 13:30:00 #> 3 md-outputs 0d026c3f461965cdf8a91e… 2024-10-15 13:30:04 #> 4 sandpaper-local/gh-pages 9a5650697aa664c2ac7b07… 2024-10-15 13:30:12 #> 5 sandpaper-local/main c46bee47d4c4bebb210138… 2024-10-15 13:30:00 #> 6 sandpaper-local/md-outputs 0d026c3f461965cdf8a91e… 2024-10-15 13:30:04 # An indicator this worked: the first episode should be represented as # different files across the branches: # - main: Rmd # - md-outputs: md # - gh-pages: html cli::cli_h2(\"First episode status\") #> ── First episode status ── #> gert::git_stat_files(\"episodes/introduction.Rmd\", repo = rmt) #> # A tibble: 1 × 5 #> file created modified commits head #> * <chr> <dttm> <dttm> <int> <chr> #> 1 episodes/introd… 2024-10-15 13:30:00 2024-10-15 13:30:00 1 c46b… cli::cli_h3(\"rendered markdown\") #> ── rendered markdown gert::git_stat_files(\"introduction.md\", repo = rmt, ref = \"md-outputs\") #> # A tibble: 1 × 5 #> file created modified commits head #> * <chr> <dttm> <dttm> <int> <chr> #> 1 introduction.md 2024-10-15 13:30:04 2024-10-15 13:30:04 1 0d026… cli::cli_h3(\"html file\") #> #> ── html file gert::git_stat_files(\"introduction.html\", repo = rmt, ref = \"gh-pages\") #> # A tibble: 1 × 5 #> file created modified commits head #> * <chr> <dttm> <dttm> <int> <chr> #> 1 introduction.ht… 2024-10-15 13:30:12 2024-10-15 13:30:12 1 9a56… # CLEAN ------------------------------------------------------------------- tik <- Sys.time() cli::cli_h1(\"Clean Up\") #> #> ── Clean Up ──────────────────────────────────────────────────────────── snd$remove_local_remote(repo = res) #> ℹ removing 'sandpaper-local' (/tmp/RtmpD6AhNE/REMOTE-16ef35725b93) #> /tmp/RtmpD6AhNE/REMOTE-16ef35725b93 snd$reset_git_user(res) # remove the test fixture and report tryCatch(fs::dir_delete(res), error = function() FALSE) tok <- Sys.time() cli::cli_alert_info(\"Elapsed time: {round(tok - tik, 2)} seconds\") #> ℹ Elapsed time: 0.11 seconds"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_session_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Report session information to the user — ci_session_info","title":"Report session information to the user — ci_session_info","text":"function used continuous integration report packages used building site pull requests","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_session_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Report session information to the user — ci_session_info","text":"","code":"ci_session_info()"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_session_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Report session information to the user — ci_session_info","text":"Nothing, used entirely side-effect","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/copy_template.html","id":null,"dir":"Reference","previous_headings":"","what":"copy a sandpaper template file to a path with data — copy_template","title":"copy a sandpaper template file to a path with data — copy_template","text":"copy sandpaper template file path data","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/copy_template.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"copy a sandpaper template file to a path with data — copy_template","text":"","code":"copy_template(template, path = NULL, name = NULL, values = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/copy_template.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"copy a sandpaper template file to a path with data — copy_template","text":"template base valid template function (e.g. \"episode\" template_episode()) path folder write file. Defaults NULL, return filled template character vector name name file. Defaults NULL values values fill template (). Consult files templates/ folder sandpaper installation details.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/copy_template.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"copy a sandpaper template file to a path with data — copy_template","text":"character vector path name NULL, otherwise, used side effect creating file.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_episode.html","id":null,"dir":"Reference","previous_headings":"","what":"Create an Episode from a template — create_episode","title":"Create an Episode from a template — create_episode","text":"functions allow create episode added schedule.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_episode.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create an Episode from a template — create_episode","text":"","code":"create_episode( title, ext = \"Rmd\", make_prefix = FALSE, add = TRUE, path = \".\", open = rlang::is_interactive() ) create_episode_md( title, make_prefix = FALSE, add = TRUE, path = \".\", open = rlang::is_interactive() ) create_episode_rmd( title, make_prefix = FALSE, add = TRUE, path = \".\", open = rlang::is_interactive() ) draft_episode_md( title, make_prefix = FALSE, path = \".\", open = rlang::is_interactive() ) draft_episode_rmd( title, make_prefix = FALSE, path = \".\", open = rlang::is_interactive() )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_episode.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create an Episode from a template — create_episode","text":"title title episode ext character. ext = \"Rmd\" (default), new episode R Markdown episode. ext = \"md\", new episode markdown episode, can generate dynamic content. make_prefix logical. TRUE, prefix file automatically determined files already present. FALSE (default), assumes prefix needed. add (logical numeric) numeric, represents position episode added. TRUE, episode added end schedule. FALSE, episode added draft episode. path path {sandpaper} lesson. open interactive, episode open new editor window.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_episode.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create an Episode from a template — create_episode","text":"","code":"tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4982f199... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4982f199... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4982f199... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4982f199... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4982f199... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef4982f199/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4982f199... #> ✔ First episode created in /tmp/RtmpD6AhNE/file16ef4982f199/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4982f199... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4982f199... #> ✔ Lesson successfully created in /tmp/RtmpD6AhNE/file16ef4982f199 #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4982f199... #> /tmp/RtmpD6AhNE/file16ef4982f199 create_episode_md(\"getting-started\", path = tmp) #> ☐ Edit /tmp/RtmpD6AhNE/file16ef4982f199/episodes/getting-started.md. #> /tmp/RtmpD6AhNE/file16ef4982f199/episodes/getting-started.md"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_lesson.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a carpentries lesson — create_lesson","title":"Create a carpentries lesson — create_lesson","text":"create boilerplate directory structure Carpentries lesson initialize git repository.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_lesson.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a carpentries lesson — create_lesson","text":"","code":"create_lesson( path, name = fs::path_file(path), rmd = TRUE, rstudio = rstudioapi::isAvailable(), open = rlang::is_interactive() )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_lesson.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a carpentries lesson — create_lesson","text":"path path new lesson folder name name lesson. provided, folder name used. rmd logical indicator lesson use R Markdown (TRUE, default), use Markdown (FALSE). Note lessons can converted use R Markdown time adding file .Rmd file extension lesson. rstudio create RStudio project (defaults RStudio exits) open interactive, lesson open new editor window.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_lesson.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a carpentries lesson — create_lesson","text":"path new lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_lesson.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a carpentries lesson — create_lesson","text":"","code":"tmp <- tempfile() on.exit(unlink(tmp)) lsn <- create_lesson(tmp, name = \"This Lesson\", open = FALSE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef3140e2ce... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef3140e2ce... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef3140e2ce... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef3140e2ce... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef3140e2ce... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef3140e2ce/episodes/introduction.Rmd. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef3140e2ce... #> ✔ First episode created in /tmp/RtmpD6AhNE/file16ef3140e2ce/episodes/introduction.Rmd #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef3140e2ce... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef3140e2ce... #> ℹ Consent to use package cache provided #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef3140e2ce... #> - The project is out-of-sync -- use `renv::status()` for details. #> → Searching for and installing available dependencies #> The following packages were discovered: #> #> # ~/work/_temp/Library ------------------------------------------------------- #> - R6 2.5.1 #> - base64enc 0.1-3 #> - bslib 0.8.0 #> - cachem 1.1.0 #> - cli 3.6.3 #> - digest 0.6.37 #> - evaluate 1.0.1 #> - fastmap 1.2.0 #> - fontawesome 0.5.2 #> - fs 1.6.4 #> - glue 1.8.0 #> - highr 0.11 #> - htmltools 0.5.8.1 #> - jquerylib 0.1.4 #> - jsonlite 1.8.9 #> - knitr 1.48 #> - lifecycle 1.0.4 #> - memoise 2.0.1 #> - mime 0.12 #> - rappdirs 0.3.3 #> - rlang 1.1.4 #> - rmarkdown 2.28 #> - sass 0.4.9 #> - tinytex 0.53 #> - xfun 0.48 #> - yaml 2.3.10 #> #> They will be copied into the project library. #> #> - Copying packages into the project library ... Done! #> - Hydrated 26 packages in 0.21 seconds. #> - The project is out-of-sync -- use `renv::status()` for details. #> → Recording changes in lockfile #> The following package(s) will be updated in the lockfile: #> #> # https://packagemanager.posit.co/cran/__linux__/jammy/latest ---------------- #> - R6 [* -> 2.5.1] #> - base64enc [* -> 0.1-3] #> - bslib [* -> 0.8.0] #> - cachem [* -> 1.1.0] #> - cli [* -> 3.6.3] #> - digest [* -> 0.6.37] #> - evaluate [* -> 1.0.1] #> - fastmap [* -> 1.2.0] #> - fontawesome [* -> 0.5.2] #> - fs [* -> 1.6.4] #> - glue [* -> 1.8.0] #> - highr [* -> 0.11] #> - htmltools [* -> 0.5.8.1] #> - jquerylib [* -> 0.1.4] #> - jsonlite [* -> 1.8.9] #> - knitr [* -> 1.48] #> - lifecycle [* -> 1.0.4] #> - memoise [* -> 2.0.1] #> - mime [* -> 0.12] #> - rappdirs [* -> 0.3.3] #> - renv [* -> 1.0.11] #> - rlang [* -> 1.1.4] #> - rmarkdown [* -> 2.28] #> - sass [* -> 0.4.9] #> - tinytex [* -> 0.53] #> - xfun [* -> 0.48] #> - yaml [* -> 2.3.10] #> #> The version of R recorded in the lockfile will be updated: #> - R [* -> 4.4.1] #> #> - Lockfile written to \"/tmp/RtmpD6AhNE/file16ef3140e2ce/renv/profiles/lesson-requirements/renv.lock\". #> ✔ Lesson successfully created in /tmp/RtmpD6AhNE/file16ef3140e2ce #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef3140e2ce... lsn #> /tmp/RtmpD6AhNE/file16ef3140e2ce"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar.html","id":null,"dir":"Reference","previous_headings":"","what":"Create the sidebar for varnish — create_resources_dropdown","title":"Create the sidebar for varnish — create_resources_dropdown","text":"Varnish uses sidebar navigation across within episode. episode's sidebar different needs clear indicator episode current one within sidebar.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create the sidebar for varnish — create_resources_dropdown","text":"","code":"create_resources_dropdown(files, type = \"learners\") create_sidebar( chapters, name = \"\", html = \"<a href='https://carpentries.org'/>\" ) update_sidebar( sidebar = NULL, nodes = NULL, this_page = NULL, title = NULL, item = NULL )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create the sidebar for varnish — create_resources_dropdown","text":"files vector markdown file names type one \"learners\" (default) \"instructors\". learners, setup page excluded since included index. \"instructors\", instructor notes included learner profiles included. chapters character vector paths markdown chapters name name current chapter html html current chapter. defaults link produce sidebar links headings. sidebar object class \"list-store\" \"sidebar\" element stored list. See set_globals(). nodes HTML nodes HTML page this_page path current HTML page title current title item index sidebar item update","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create the sidebar for varnish — create_resources_dropdown","text":"character vector HTML divs can appended display sidebar.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create the sidebar for varnish — create_resources_dropdown","text":"function creates sidebar.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a single item that appears in the sidebar — create_sidebar_item","title":"Create a single item that appears in the sidebar — create_sidebar_item","text":"Varnish uses sidebar navigation across within episode. funciton create sidebar item single episode, providing dropdown menu sections within episode labeled current episode.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a single item that appears in the sidebar — create_sidebar_item","text":"","code":"create_sidebar_item(nodes, link, position) create_sidebar_headings(nodes)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a single item that appears in the sidebar — create_sidebar_item","text":"nodes html nodes webpage generated render_html() parsed xml2 level 2 section headings class section-heading link character vector length 1 defines HTML links used node sidebar item. position either number \"current\", \"current\", html parsed second level headings list sidebar navigation.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar_item.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a single item that appears in the sidebar — create_sidebar_item","text":"character vector div item insert sidebar navigation","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar_item.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a single item that appears in the sidebar — create_sidebar_item","text":"","code":"snd <- asNamespace(\"sandpaper\") html <- c( \"<section id='one'><h2 class='section-heading'>Section 1<\/h2><p>section 1<\/p><\/section>\", \"<section id='two'><h2 class='section-heading'>Section 2<\/h2><p>section 2<\/p><\/section>\" ) nodes <- xml2::read_html(paste(html, collapse = \"\\n\")) # The sidebar headings are extracted from the nodes writeLines(snd$create_sidebar_headings(nodes)) #> <li><a href='#one'>Section 1<\/a><\/li> #> <li><a href='#two'>Section 2<\/a><\/li> link <- \"<a href='https://example.com/this-page.html'><em>This Page<\/em><\/a>\" # the sidebar item will contain the headings if it is the current chapter writeLines(snd$create_sidebar_item(nodes, link, position = \"current\")) #> <div class=\"accordion accordion-flush\" id=\"accordionFlushcurrent\"> #> <div class=\"accordion-item\"> #> <div class=\"accordion-header\" id=\"flush-headingcurrent\"> #> <button class=\"accordion-button\" type=\"button\" data-bs-toggle=\"collapse\" data-bs-target=\"#flush-collapsecurrent\" aria-expanded=\"true\" aria-controls=\"flush-collapsecurrent\"> #> <span class=\"visually-hidden\">Current Chapter<\/span> #> <span class=\"current-chapter\"> #> <a href='https://example.com/this-page.html'><em>This Page<\/em><\/a> #> <\/span> #> <\/button> #> <\/div><!--/div.accordion-header--> #> #> <div id=\"flush-collapsecurrent\" class=\"accordion-collapse collapse show\" aria-labelledby=\"flush-headingcurrent\" data-bs-parent=\"#accordionFlushcurrent\"> #> <div class=\"accordion-body\"> #> <ul> #> <li><a href='#one'>Section 1<\/a><\/li> #> <li><a href='#two'>Section 2<\/a><\/li> #> <\/ul> #> <\/div><!--/div.accordion-body--> #> <\/div><!--/div.accordion-collapse--> #> #> <\/div><!--/div.accordion-item--> #> <\/div><!--/div.accordion-flush--> #> # it will be an ordinary link otherwise writeLines(snd$create_sidebar_item(nodes, link, position = 3)) #> <div class=\"accordion accordion-flush\" id=\"accordionFlush3\"> #> <div class=\"accordion-item\"> #> <div class=\"accordion-header\" id=\"flush-heading3\"> #> <a href='https://example.com/this-page.html'><em>This Page<\/em><\/a> #> <\/div><!--/div.accordion-header--> #> #> <\/div><!--/div.accordion-item--> #> <\/div><!--/div.accordion-flush--> #>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dependency_management.html","id":null,"dir":"Reference","previous_headings":"","what":"Lesson Runtime Dependency Management — manage_deps","title":"Lesson Runtime Dependency Management — manage_deps","text":"customized provisioner Carpentries Lessons based renv install maintain requirements lesson respecting user environments. setup leads several advantages: reliable setup: version lesson built carpentries website build computer packages identical environmentally friendly: lesson dependencies stored default R library alter R environment. transparent: additions deletions cache recorded lockfile, tracked git. functions control cache following: manage_deps(): Creates updates dependencies lesson. lockfile exists lesson, create one . update_cache(): fetches updates dependencies applies cache lockfile. wrapper around renv::record(), helps record package set packages lockfile. can useful want upgrade downgrade specific package.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dependency_management.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lesson Runtime Dependency Management — manage_deps","text":"","code":"manage_deps( path = \".\", profile = \"lesson-requirements\", snapshot = TRUE, quiet = FALSE ) update_cache( path = \".\", profile = \"lesson-requirements\", prompt = interactive(), quiet = !prompt, snapshot = TRUE ) pin_version(records = NULL, profile = \"lesson-requirements\", path = \".\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dependency_management.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lesson Runtime Dependency Management — manage_deps","text":"path path lesson. Defaults current working directory. profile default profile lesson. Defaults lesson-requirements. use know . snapshot TRUE, packages cache added lockfile (default). Setting FALSE add packages cache snapshot . quiet TRUE, output suppressed, defaults FALSE, providing output different steps process updating local dependencies. prompt TRUE, message show packages updated lockfile ask permission. default running interactive session. records character vector list packages/resources include lockfile. common way use [package]@[version] syntax (e.g. gert@0.1.3), specifications can specify remote repository. See renv::record() details.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dependency_management.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lesson Runtime Dependency Management — manage_deps","text":"snapshot = TRUE, nested list representing lockfile returned. contents lockfile, invisibly","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dependency_management.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Lesson Runtime Dependency Management — manage_deps","text":"renv package provides useful interface bring one aspect reproducibility R projects. people working Carpentries lessons also working academics likely projects computer package versions necessary work, important environments respected. flavor {renv} applies package cache explicitly content lesson, impose default {renv} environment. provisioner following steps: check consent use package cache via use_package_cache() prompt needed check profile created create needed via renv::init() populate cache packages needed user's system download missing via renv::hydrate(). includes new packages added lesson. lockfile already present, make sure packages cache aligned lockfile (downloading sources needed) via renv::restore(). Record state cache lockfile tracked git. include adding new packages removing old packages. renv::snapshot() lockfile changes, see git power either commit restore changes.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dot-lesson_store.html","id":null,"dir":"Reference","previous_headings":"","what":"Internal Global Lesson Storage Generator — .lesson_store","title":"Internal Global Lesson Storage Generator — .lesson_store","text":"function generate object store contain update lesson object based status git repository","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dot-lesson_store.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Internal Global Lesson Storage Generator — .lesson_store","text":"","code":".lesson_store()"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dot-lesson_store.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Internal Global Lesson Storage Generator — .lesson_store","text":"list four functions operate supplied path string get() returns .this_lesson (described this_lesson()) set(path) sets .this_lesson git statuses lesson path. also sets set_globals() set_resource_list(). valid(path) uses path validate lesson identical stored lesson git status. Returns TRUE identical FALSE clear() resets global variables.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dot-list_store.html","id":null,"dir":"Reference","previous_headings":"","what":"List Storage Generator — .list_store","title":"List Storage Generator — .list_store","text":"function generate object can serve persistant storage pre-computed values. object contains list called .this_list embedded within enviroment created .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dot-list_store.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List Storage Generator — .list_store","text":"","code":".list_store()"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dot-list_store.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List Storage Generator — .list_store","text":"list five functions operate internal .this_list list object: get() returns value .this_list update(value) updates .this_list modified list value. Useful adding several pieces information . set(key, value) sets given key (vector, element representing level nesting) particular value (can vector list). key NULL, .this_list replaced value clear() sets .this_list NULL copy() creates independent copy object modification.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dot-list_store.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List Storage Generator — .list_store","text":"","code":"if (FALSE) { # note: asNamespace() gives access to internal functions. This is for # demonstration purposes only. There is no guarantee for these functions to # work. global_list <- asNamespace(\"sandpaper\")$.list_store() global_list$set(key = NULL, list(a = 1, b = list(2))) global_list$set(key = \"c\", \"three\") global_list$get() global_list$update(list(c = \"THREE\", d = global_list$get())) global_list$get() }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fill_translation_vars.html","id":null,"dir":"Reference","previous_headings":"","what":"Apply template items to translated strings — fill_translation_vars","title":"Apply template items to translated strings — fill_translation_vars","text":"Apply template items translated strings","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fill_translation_vars.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Apply template items to translated strings — fill_translation_vars","text":"","code":"fill_translation_vars(the_data)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fill_translation_vars.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Apply template items to translated strings — fill_translation_vars","text":"the_data list global variables (either learner_globals instructor_globals) also contains \"translate\" element containing list translated strings.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fill_translation_vars.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Apply template items to translated strings — fill_translation_vars","text":"translated list templated data filled ","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fill_translation_vars.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Apply template items to translated strings — fill_translation_vars","text":"two kinds templating use: variable templating indicated {key} key represents variable exists within global data replaced. link templating indicated <(text wrap)> replace <()> known URL HTML markup. allows translators translate text without worry HTML markup.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fill_translation_vars.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Apply template items to translated strings — fill_translation_vars","text":"","code":"dat <- list( a = \"a barn\", b = \"a bee\", minutes = 5, translate = list( one = \"a normal translated string (pretend it's translated from another language)\", two = \"a question: are you (A) {a}, (B) {b}\", EstimatedTime = \"Estimated time: {icons$clock} {minutes}\", license = \"Licensed under {license} by the authors\", ThisLessonCoC = \"This lesson operates under our <(Code of Conduct)>\" ) ) asNamespace(\"sandpaper\")$fill_translation_vars(dat) #> $one #> [1] \"a normal translated string (pretend it's translated from another language)\" #> #> $two #> a question: are you (A) a barn, (B) a bee #> #> $EstimatedTime #> Estimated time: <i aria-hidden=\"true\" data-feather=\"clock\"><\/i> 5 #> #> $license #> Licensed under <a href=\"LICENSE.html\">CC-BY 4.0<\/a> by the authors #> #> $ThisLessonCoC #> [1] \"This lesson operates under our <a href=\\\"CODE_OF_CONDUCT.html\\\">Code of Conduct<\/a>\" #>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fix_sidebar_href.html","id":null,"dir":"Reference","previous_headings":"","what":"Fix the refs for a vector of sidebar nodes — fix_sidebar_href","title":"Fix the refs for a vector of sidebar nodes — fix_sidebar_href","text":"update links list HTML node","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fix_sidebar_href.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fix the refs for a vector of sidebar nodes — fix_sidebar_href","text":"","code":"fix_sidebar_href( item, path = NULL, scheme = NULL, server = NULL, query = NULL, fragment = NULL ) make_url(parsed) append(first, sep = \"#\", last, trim = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fix_sidebar_href.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fix the refs for a vector of sidebar nodes — fix_sidebar_href","text":"item text representation HTML nodes contain <> elements. path, scheme, server, query, fragment character vectors elements replace. can single element vector, recycled vector length item. parsed data frame produced via xml2::url_parse first character vector sep character vector length 1 last character vector, length first length 1 trim logical indicating leading trailing sep trimmed first last.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fix_sidebar_href.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fix the refs for a vector of sidebar nodes — fix_sidebar_href","text":"text representation HTML nodes href element modified.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fix_sidebar_href.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Fix the refs for a vector of sidebar nodes — fix_sidebar_href","text":"Repeat : parsing HTML regular expressions bad. function uses xml2::read_html() parse incoming HTML content convert HTML string XML document can extract anchor links, parse replace contents without regex. acheived via xml2::url_parse() separating URL pieces updating pieces node. fix_sidebar_href() useful sidebar nodes needs updated 404 page links use published URL. NOTE: take account port user. auxilary functions make_url(), append() prepend() used convert output xml2::url_parse() back URL.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fix_sidebar_href.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fix the refs for a vector of sidebar nodes — fix_sidebar_href","text":"","code":"my_links <- c( \"<div id='one'><div id='one-one'><a href='index.html'>Index<\/a><\/div><\/div>\", \"<div id='two'><div id='two-two'><a href='two.html'><em>Two<\/em><\/a><\/div><\/div>\", \"<div id='three'><div id='three-three'><a href='three.html'>Three<\/a><\/div><\/div>\", \"<div id='four'><div id='four-four'><a href='four.html'>Four<\/a><\/div><\/div>\", \"<div id='five'><div id='five-five'><a href='five.html'>Five<\/a><\/div><\/div>\" ) snd <- asNamespace(\"sandpaper\") # Prepend a server to the links snd$fix_sidebar_href(my_links, scheme = \"https\", server = \"example.com\") #> [1] \"<div id=\\\"one\\\"><div id=\\\"one-one\\\"><a href=\\\"https://example.com/index.html\\\">Index<\/a><\/div><\/div>\" #> [2] \"<div id=\\\"two\\\"><div id=\\\"two-two\\\"><a href=\\\"https://example.com/two.html\\\"><em>Two<\/em><\/a><\/div><\/div>\" #> [3] \"<div id=\\\"three\\\"><div id=\\\"three-three\\\"><a href=\\\"https://example.com/three.html\\\">Three<\/a><\/div><\/div>\" #> [4] \"<div id=\\\"four\\\"><div id=\\\"four-four\\\"><a href=\\\"https://example.com/four.html\\\">Four<\/a><\/div><\/div>\" #> [5] \"<div id=\\\"five\\\"><div id=\\\"five-five\\\"><a href=\\\"https://example.com/five.html\\\">Five<\/a><\/div><\/div>\" snd$fix_sidebar_href(my_links, server = \"https://example.com\") #> [1] \"<div id=\\\"one\\\"><div id=\\\"one-one\\\"><a href=\\\"https://example.com/index.html\\\">Index<\/a><\/div><\/div>\" #> [2] \"<div id=\\\"two\\\"><div id=\\\"two-two\\\"><a href=\\\"https://example.com/two.html\\\"><em>Two<\/em><\/a><\/div><\/div>\" #> [3] \"<div id=\\\"three\\\"><div id=\\\"three-three\\\"><a href=\\\"https://example.com/three.html\\\">Three<\/a><\/div><\/div>\" #> [4] \"<div id=\\\"four\\\"><div id=\\\"four-four\\\"><a href=\\\"https://example.com/four.html\\\">Four<\/a><\/div><\/div>\" #> [5] \"<div id=\\\"five\\\"><div id=\\\"five-five\\\"><a href=\\\"https://example.com/five.html\\\">Five<\/a><\/div><\/div>\" # Add an anchor to the links snd$fix_sidebar_href(my_links, scheme = \"https\", fragment = \"anchor\") #> [1] \"<div id=\\\"one\\\"><div id=\\\"one-one\\\"><a href=\\\"https://index.html#anchor\\\">Index<\/a><\/div><\/div>\" #> [2] \"<div id=\\\"two\\\"><div id=\\\"two-two\\\"><a href=\\\"https://two.html#anchor\\\"><em>Two<\/em><\/a><\/div><\/div>\" #> [3] \"<div id=\\\"three\\\"><div id=\\\"three-three\\\"><a href=\\\"https://three.html#anchor\\\">Three<\/a><\/div><\/div>\" #> [4] \"<div id=\\\"four\\\"><div id=\\\"four-four\\\"><a href=\\\"https://four.html#anchor\\\">Four<\/a><\/div><\/div>\" #> [5] \"<div id=\\\"five\\\"><div id=\\\"five-five\\\"><a href=\\\"https://five.html#anchor\\\">Five<\/a><\/div><\/div>\" # NOTE: this will _always_ return a character vector, even if the input is # incorrect snd$fix_sidebar_href(list(), server = \"example.com\") #> [1] \"\""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":null,"dir":"Reference","previous_headings":"","what":"Test fixture functions for sandpaper — create_test_lesson","title":"Test fixture functions for sandpaper — create_test_lesson","text":"suite functions use testing {sandpaper} designed create/work temporary lesson associated remote repository (locally) persists throughout test suite. functions used tests/testthat/setup.R. information, see package scope section testthat article Test Fixtures.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Test fixture functions for sandpaper — create_test_lesson","text":"","code":"create_test_lesson() generate_restore_fixture(repo) setup_local_remote( repo, remote = tempfile(), name = \"sandpaper-local\", verbose = FALSE ) make_branch(repo, branch = NULL, name = \"sandpaper-local\", verbose = FALSE) clean_branch(repo, branch = NULL, name = \"sandpaper-local\", verbose = FALSE) remove_local_remote(repo, name = \"sandpaper-local\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Test fixture functions for sandpaper — create_test_lesson","text":"repo path git repository remote path empty uninitialized directory. Defaults tempfile name remote, defaults \"sandpaper-local\" verbose TRUE, messages output git printed screen. Defaults FALSE. branch name new branch deleted","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Test fixture functions for sandpaper — create_test_lesson","text":"(generate_restore_fixture) function restore test fixture (setup_local_remote()) repo, invisibly (remove_local_remote()) FALSE indicating error string indicating path remote","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"create-test-lesson-","dir":"Reference","previous_headings":"","what":"create_test_lesson()","title":"Test fixture functions for sandpaper — create_test_lesson","text":"creates test lesson calls generate_restore_fixture() path new test lesson.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"generate-restore-fixture-","dir":"Reference","previous_headings":"","what":"generate_restore_fixture()","title":"Test fixture functions for sandpaper — create_test_lesson","text":"creates function restore lesson previous commit.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"setup-local-remote-","dir":"Reference","previous_headings":"","what":"setup_local_remote()","title":"Test fixture functions for sandpaper — create_test_lesson","text":"Creates local remote repository separate temporary folder, linked fixture lesson.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"make-branch-","dir":"Reference","previous_headings":"","what":"make_branch()","title":"Test fixture functions for sandpaper — create_test_lesson","text":"create branch local repository push remote repository.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"clean-branch-","dir":"Reference","previous_headings":"","what":"clean_branch()","title":"Test fixture functions for sandpaper — create_test_lesson","text":"delete branch local remote repository.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"remove-local-remote-","dir":"Reference","previous_headings":"","what":"remove_local_remote()","title":"Test fixture functions for sandpaper — create_test_lesson","text":"Destorys local remote repository removes fixture lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Test fixture functions for sandpaper — create_test_lesson","text":"implemented tests/testthat/setup.md","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_config.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the configuration parameters for the lesson — get_config","title":"Get the configuration parameters for the lesson — get_config","text":"Get configuration parameters lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_config.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the configuration parameters for the lesson — get_config","text":"","code":"get_config(path = \".\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_config.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the configuration parameters for the lesson — get_config","text":"path path lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_config.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the configuration parameters for the lesson — get_config","text":"yaml list","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_config.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get the configuration parameters for the lesson — get_config","text":"","code":"tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6274e81e... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6274e81e... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6274e81e... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6274e81e... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6274e81e... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef6274e81e/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6274e81e... #> ✔ First episode created in /tmp/RtmpD6AhNE/file16ef6274e81e/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6274e81e... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6274e81e... #> ✔ Lesson successfully created in /tmp/RtmpD6AhNE/file16ef6274e81e #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6274e81e... #> /tmp/RtmpD6AhNE/file16ef6274e81e get_config(tmp) #> $carpentry #> [1] \"incubator\" #> #> $title #> [1] \"Lesson Title\" #> #> $created #> [1] \"2024-10-15\" #> #> $keywords #> [1] \"software, data, lesson, The Carpentries\" #> #> $life_cycle #> [1] \"pre-alpha\" #> #> $license #> [1] \"CC-BY 4.0\" #> #> $source #> [1] \"https://github.com/carpentries/file16ef6274e81e\" #> #> $branch #> [1] \"main\" #> #> $contact #> [1] \"team@carpentries.org\" #> #> $episodes #> [1] \"introduction.md\" #> #> $learners #> NULL #> #> $instructors #> NULL #> #> $profiles #> NULL #>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_content.html","id":null,"dir":"Reference","previous_headings":"","what":"Get sections from an episode's HTML page — get_content","title":"Get sections from an episode's HTML page — get_content","text":"Get sections episode's HTML page","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_content.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get sections from an episode's HTML page — get_content","text":"","code":"get_content( episode, content = \"*\", label = FALSE, pkg = NULL, instructor = FALSE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_content.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get sections from an episode's HTML page — get_content","text":"episode object class xml_document, path markdown html file episode. content XPath fragment. defaults \"*\" label TRUE, elements named ids. best used content = \"section\". pkg object created via pkgdown::as_pkgdown() lesson. instructor TRUE, instructor version episode read, defaults FALSE. effect episode xml_document.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_content.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get sections from an episode's HTML page — get_content","text":"contents lesson contained following templating cascade: function extract content episode without templating.","code":"<body> <div class='container'> <div class='row'> <div class='[...] primary-content'> <main> <div class='[...] lesson-content'> CONTENT HERE"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_content.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get sections from an episode's HTML page — get_content","text":"","code":"if (FALSE) { lsn <- \"/path/to/lesson\" pkg <- pkgdown::as_pkgdown(fs::path(lsn, \"site\")) # for AiO pages, this will return only the top-level sections: get_content(\"aio\", content = \"section\", label = TRUE, pkg = pkg) # for episode pages, this will return everything that's not template get_content(\"01-introduction\", pkg = pkg) # for things that are within lessons but we don't know their exact location, # we can prefix a `/` to double up the slash, which will produce }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_drafts.html","id":null,"dir":"Reference","previous_headings":"","what":"Show files in draft form — get_drafts","title":"Show files in draft form — get_drafts","text":"default, {sandpaper} use files alphabetical order presented folders, however, strongly authors specify order files lessons, easy rearrange add, split, rearrange files.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_drafts.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Show files in draft form — get_drafts","text":"","code":"get_drafts( path, folder = NULL, message = getOption(\"sandpaper.show_draft\", TRUE) )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_drafts.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Show files in draft form — get_drafts","text":"path path sandpaper lesson folder specific folder list draft files. Defaults NULL, indicates folders listed config.yaml. message TRUE (default), informative message files draft status printed screen.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_drafts.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Show files in draft form — get_drafts","text":"vector paths files draft message (specified)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_drafts.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Show files in draft form — get_drafts","text":"mechanism also allows authors work files draft form without published. function list show files draft automation audit.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_dropdown.html","id":null,"dir":"Reference","previous_headings":"","what":"Helpers to extract contents of dropdown menus on the site — get_dropdown","title":"Helpers to extract contents of dropdown menus on the site — get_dropdown","text":"fuction extract resources exist listed config file.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_dropdown.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helpers to extract contents of dropdown menus on the site — get_dropdown","text":"","code":"get_dropdown(path = \".\", folder, trim = TRUE) get_episodes(path = \".\", trim = TRUE) get_learners(path = \".\", trim = TRUE) get_instructors(path = \".\", trim = TRUE) get_profiles(path = \".\", trim = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_dropdown.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helpers to extract contents of dropdown menus on the site — get_dropdown","text":"path path lesson, defaults current working directory folder folder extract fromt dropdown menues trim TRUE (default), file name presented. FALSE, full path prepended.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_dropdown.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helpers to extract contents of dropdown menus on the site — get_dropdown","text":"character vector episodes order presentation","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_dropdown.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Helpers to extract contents of dropdown menus on the site — get_dropdown","text":"","code":"tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2ff58bb8... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2ff58bb8... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2ff58bb8... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2ff58bb8... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2ff58bb8... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef2ff58bb8/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2ff58bb8... #> ✔ First episode created in /tmp/RtmpD6AhNE/file16ef2ff58bb8/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2ff58bb8... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2ff58bb8... #> ✔ Lesson successfully created in /tmp/RtmpD6AhNE/file16ef2ff58bb8 #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef2ff58bb8... #> /tmp/RtmpD6AhNE/file16ef2ff58bb8 get_episodes(tmp) #> [1] \"introduction.md\" get_learners(tmp) # information for learners #> [1] \"reference.md\" \"setup.md\""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_nav_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate the navigation data for a page — get_nav_data","title":"Generate the navigation data for a page — get_nav_data","text":"Generate navigation data page","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_nav_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate the navigation data for a page — get_nav_data","text":"","code":"get_nav_data( path_md, path_src = NULL, home = NULL, this_page = NULL, page_back = NULL, page_forward = NULL )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_nav_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate the navigation data for a page — get_nav_data","text":"path_md path episode markdown (RMarkdown) file (usually via build_episode_md()). path_src default NULL indicating source file determined sandpaper-source entry yaml header. present, option allows specify file. home path lesson home this_page current page relative html address page_back URL previous page page_forward URL next page","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_resource_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the full resource list of markdown files — get_resource_list","title":"Get the full resource list of markdown files — get_resource_list","text":"Get full resource list markdown files","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_resource_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the full resource list of markdown files — get_resource_list","text":"","code":"get_resource_list(path, trim = FALSE, subfolder = NULL, warn = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_resource_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the full resource list of markdown files — get_resource_list","text":"path path lesson trim TRUE, trim paths relative lesson directory. Defaults FALSE, return absolute paths subfolder subfolder check. NULL, folders checked returned (default), otherwise, string specifying folder name lesson (e.g. \"episodes\"). warn TRUE subfolder = \"episodes\", message issued user episodes field configuration file empty.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_resource_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the full resource list of markdown files — get_resource_list","text":"list files subfolder order appear menu.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_syllabus.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a syllabus for the lesson — get_syllabus","title":"Create a syllabus for the lesson — get_syllabus","text":"function generally internal use, may useful whish automate creation home pages.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_syllabus.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a syllabus for the lesson — get_syllabus","text":"","code":"get_syllabus(path = \".\", questions = FALSE, use_built = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_syllabus.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a syllabus for the lesson — get_syllabus","text":"path path lesson questions TRUE, questions episodes added table. Defaults FALSE. use_built TRUE (default), rendered episodes used generate syllabus","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_syllabus.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a syllabus for the lesson — get_syllabus","text":"data frame containing syllabus lesson timing, links, questions associated","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/git_worktree.html","id":null,"dir":"Reference","previous_headings":"","what":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","title":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","text":"Setup git worktree concurrent manipulation separate branch","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/git_worktree.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","text":"","code":"git_worktree_setup( path = \".\", dest_dir, branch = \"gh-pages\", remote = \"origin\", throwaway = FALSE ) github_worktree_commit(dir, commit_message, remote, branch) github_worktree_remove(dir, home = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/git_worktree.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","text":"path path repository dest_dir path destination directory contain work tree branch branch associated work tree (default: gh-pages) remote remote name (default: origin) throwaway TRUE, worktree created detached HEAD state remote branch create new branch repository. Defaults FALSE, create branch upstream.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/git_worktree.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","text":"expression() calls git worktree remove worktree evaluated.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/git_worktree.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","text":"function used continuous integration settings want push derived outputs non-main branches repository. use populate markdown HTML outputs lesson rebuild lesson scratch every time. logic behind looks like","code":"worktree setup [IF BRANCH DOES NOT EXIST] git checkout --orphan <branch> git rm -rf --quiet . git commit --allow-empty -m git push remote HEAD:<branch> git checkout - git fetch <remote> +refs/heads/<branch>:refs/remotes/<remote>/<branch> git worktree add --track -B <branch> /path/to/dir <remote>/<branch>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/git_worktree.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","text":"git_worktree_setup() modified logic pkgdown::deploy_to_branch(), Hadley Wickham. github_worktree_commit(): Modified pkgdown:::github_push Hadley Wickham github_worktree_remove(): Modified pkgdown:::github_worktree_remove Hadley Wickham","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/git_worktree.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","text":"","code":"# Use Worktrees to deploy a lesson ----------------------------------------- # This example is a bit inovlved, but it is effectively what we do inside of # the `ci_deploy()` function (after setting up the lesson). # # The setup phase will create a new lesson and a corresponding remote (self # contained, no GitHub authentication required). # # The worktrees will be created for both the markdown and HTML outputs on the # branches \"md-outputs\" and \"gh-pages\", respectively. # # After the worktrees are created, we will build the lesson into the # worktrees and display the output of `git_status()` for each of the three # branches: \"main\", \"md-outputs\", and \"gh-pages\" # # During the clean up phase, the output of `git_worktree_setup()` is # evaluated tik <- Sys.time() cli::cli_h1(\"Set up\") #> #> ── Set up ────────────────────────────────────────────────────────────── cli::cli_h2(\"Create Lesson\") #> #> ── Create Lesson ── #> restore_fixture <- sandpaper:::create_test_lesson() #> → Bootstrapping example lesson #> ℹ Lesson bootstrapped in 3.017226 secs #> → Bootstrapping example lesson res <- getOption(\"sandpaper.test_fixture\") sandpaper:::check_git_user(res) cli::cli_h2(\"Create Remote\") #> #> ── Create Remote ── #> rmt <- fs::file_temp(pattern = \"REMOTE-\") sandpaper:::setup_local_remote(repo = res, remote = rmt, verbose = FALSE) #> ℹ Remote set up in 0.01443672 secs tok <- Sys.time() cli::cli_alert_info(\"Elapsed time: {round(tok - tik, 2)} seconds\") #> ℹ Elapsed time: 3.05 seconds tik <- Sys.time() cli::cli_h2(\"Create Worktrees\") #> #> ── Create Worktrees ── #> db <- sandpaper:::git_worktree_setup(res, fs::path(res, \"site\", \"built\"), branch = \"md-outputs\", remote = \"sandpaper-local\" ) #> ::group::Create New Branch #> Running git checkout --orphan md-outputs #> Switched to a new branch 'md-outputs' #> Running git rm -rf --quiet . #> Running git commit --allow-empty -m 'Initializing md-outputs branch' #> [md-outputs (root-commit) 065eb2c] Initializing md-outputs branch #> Running git push sandpaper-local 'HEAD:md-outputs' #> To /tmp/RtmpD6AhNE/REMOTE-16ef41fc2832 #> * [new branch] HEAD -> md-outputs #> Running git checkout main #> Switched to branch 'main' #> Your branch is up to date with 'sandpaper-local/main'. #> ::endgroup:: #> ::group::Fetch sandpaper-local/md-outputs #> Running git remote set-branches sandpaper-local md-outputs #> Running git fetch sandpaper-local md-outputs #> From /tmp/RtmpD6AhNE/REMOTE-16ef41fc2832 #> * branch md-outputs -> FETCH_HEAD #> Running git remote set-branches sandpaper-local '*' #> ::endgroup:: #> ::group::Add worktree for sandpaper-local/md-outputs in site/built #> Running git worktree add --track -B md-outputs \\ #> /tmp/RtmpD6AhNE/file16ef10cfa90b/lesson-example/site/built \\ #> sandpaper-local/md-outputs #> Preparing worktree (resetting branch 'md-outputs'; was at 065eb2c) #> branch 'md-outputs' set up to track 'sandpaper-local/md-outputs'. #> HEAD is now at 065eb2c Initializing md-outputs branch #> ::endgroup:: ds <- sandpaper:::git_worktree_setup(res, fs::path(res, \"site\", \"docs\"), branch = \"gh-pages\", remote = \"sandpaper-local\" ) #> ::group::Create New Branch #> Running git checkout --orphan gh-pages #> Switched to a new branch 'gh-pages' #> Running git rm -rf --quiet . #> Running git commit --allow-empty -m 'Initializing gh-pages branch' #> [gh-pages (root-commit) 1e93dcc] Initializing gh-pages branch #> Running git push sandpaper-local 'HEAD:gh-pages' #> To /tmp/RtmpD6AhNE/REMOTE-16ef41fc2832 #> * [new branch] HEAD -> gh-pages #> Running git checkout main #> Switched to branch 'main' #> Your branch is up to date with 'sandpaper-local/main'. #> ::endgroup:: #> ::group::Fetch sandpaper-local/gh-pages #> Running git remote set-branches sandpaper-local gh-pages #> Running git fetch sandpaper-local gh-pages #> From /tmp/RtmpD6AhNE/REMOTE-16ef41fc2832 #> * branch gh-pages -> FETCH_HEAD #> Running git remote set-branches sandpaper-local '*' #> ::endgroup:: #> ::group::Add worktree for sandpaper-local/gh-pages in site/docs #> Running git worktree add --track -B gh-pages \\ #> /tmp/RtmpD6AhNE/file16ef10cfa90b/lesson-example/site/docs \\ #> sandpaper-local/gh-pages #> Preparing worktree (resetting branch 'gh-pages'; was at 1e93dcc) #> branch 'gh-pages' set up to track 'sandpaper-local/gh-pages'. #> HEAD is now at 1e93dcc Initializing gh-pages branch #> ::endgroup:: tok <- Sys.time() cli::cli_alert_info(\"Elapsed time: {round(tok - tik, 2)} seconds\") #> ℹ Elapsed time: 0.36 seconds tik <- Sys.time() cli::cli_h1(\"Build Lesson into worktrees\") #> #> ── Build Lesson into worktrees ───────────────────────────────────────── build_lesson(res, quiet = TRUE, preview = FALSE) #> ── Initialising site ─────────────────────────────────────────────────── #> Copying <pkgdown>/BS3/assets/bootstrap-toc.css to bootstrap-toc.css #> Copying <pkgdown>/BS3/assets/bootstrap-toc.js to bootstrap-toc.js #> Copying <pkgdown>/BS3/assets/docsearch.css to docsearch.css #> Copying <pkgdown>/BS3/assets/docsearch.js to docsearch.js #> Copying <pkgdown>/BS3/assets/link.svg to link.svg #> Copying <pkgdown>/BS3/assets/pkgdown.css to pkgdown.css #> Copying <pkgdown>/BS3/assets/pkgdown.js to pkgdown.js #> Copying <varnish>/pkgdown/assets/android-chrome-192x192.png to #> android-chrome-192x192.png #> Copying <varnish>/pkgdown/assets/android-chrome-512x512.png to #> android-chrome-512x512.png #> Copying <varnish>/pkgdown/assets/apple-touch-icon.png to #> apple-touch-icon.png #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.ttf to #> assets/fonts/Mulish-Bold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.woff to #> assets/fonts/Mulish-Bold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.ttf to #> assets/fonts/Mulish-ExtraBold.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.eot to #> assets/fonts/mulish-v5-latin-regular.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.svg to #> assets/fonts/mulish-v5-latin-regular.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.ttf to #> assets/fonts/mulish-v5-latin-regular.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff to #> assets/fonts/mulish-v5-latin-regular.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff2 to #> assets/fonts/mulish-v5-latin-regular.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff to #> assets/fonts/mulish-variablefont_wght.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff2 to #> assets/fonts/mulish-variablefont_wght.woff2 #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo-sm.svg #> to assets/images/carpentries-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo.svg to #> assets/images/carpentries-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo-sm.svg to #> assets/images/data-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo.svg to #> assets/images/data-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/dropdown-arrow.svg to #> assets/images/dropdown-arrow.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo-sm.svg to #> assets/images/incubator-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo.svg to #> assets/images/incubator-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo-sm.svg to #> assets/images/lab-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo.svg to #> assets/images/lab-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo-sm.svg to #> assets/images/library-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo.svg to #> assets/images/library-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/minus.svg to #> assets/images/minus.svg #> Copying <varnish>/pkgdown/assets/assets/images/plus.svg to #> assets/images/plus.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo-sm.svg to #> assets/images/software-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo.svg to #> assets/images/software-logo.svg #> Copying <varnish>/pkgdown/assets/assets/scripts.js to assets/scripts.js #> Copying <varnish>/pkgdown/assets/assets/styles.css to assets/styles.css #> Copying <varnish>/pkgdown/assets/assets/styles.css.map to #> assets/styles.css.map #> Copying <varnish>/pkgdown/assets/assets/themetoggle.js to #> assets/themetoggle.js #> Copying <varnish>/pkgdown/assets/favicon-16x16.png to favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicon-32x32.png to favicon-32x32.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-114x114.png to #> favicons/cp/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-120x120.png to #> favicons/cp/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-144x144.png to #> favicons/cp/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-152x152.png to #> favicons/cp/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-57x57.png #> to favicons/cp/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-60x60.png #> to favicons/cp/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-72x72.png #> to favicons/cp/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-76x76.png #> to favicons/cp/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-128.png to #> favicons/cp/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-16x16.png to #> favicons/cp/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-196x196.png to #> favicons/cp/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-32x32.png to #> favicons/cp/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-96x96.png to #> favicons/cp/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon.ico to #> favicons/cp/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-144x144.png to #> favicons/cp/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-150x150.png to #> favicons/cp/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x150.png to #> favicons/cp/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x310.png to #> favicons/cp/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-70x70.png to #> favicons/cp/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-114x114.png to #> favicons/dc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-120x120.png to #> favicons/dc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-144x144.png to #> favicons/dc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-152x152.png to #> favicons/dc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-57x57.png #> to favicons/dc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-60x60.png #> to favicons/dc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-72x72.png #> to favicons/dc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-76x76.png #> to favicons/dc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-128.png to #> favicons/dc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-16x16.png to #> favicons/dc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-196x196.png to #> favicons/dc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-32x32.png to #> favicons/dc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-96x96.png to #> favicons/dc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon.ico to #> favicons/dc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-144x144.png to #> favicons/dc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-150x150.png to #> favicons/dc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x150.png to #> favicons/dc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x310.png to #> favicons/dc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-70x70.png to #> favicons/dc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-114x114.png to #> favicons/lc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-120x120.png to #> favicons/lc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-144x144.png to #> favicons/lc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-152x152.png to #> favicons/lc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-57x57.png #> to favicons/lc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-60x60.png #> to favicons/lc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-72x72.png #> to favicons/lc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-76x76.png #> to favicons/lc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-128.png to #> favicons/lc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-16x16.png to #> favicons/lc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-196x196.png to #> favicons/lc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-32x32.png to #> favicons/lc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-96x96.png to #> favicons/lc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon.ico to #> favicons/lc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-144x144.png to #> favicons/lc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-150x150.png to #> favicons/lc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x150.png to #> favicons/lc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x310.png to #> favicons/lc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-70x70.png to #> favicons/lc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-114x114.png to #> favicons/swc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-120x120.png to #> favicons/swc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-144x144.png to #> favicons/swc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-152x152.png to #> favicons/swc/apple-touch-icon-152x152.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-57x57.png to #> favicons/swc/apple-touch-icon-57x57.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-60x60.png to #> favicons/swc/apple-touch-icon-60x60.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-72x72.png to #> favicons/swc/apple-touch-icon-72x72.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-76x76.png to #> favicons/swc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-128.png to #> favicons/swc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-16x16.png to #> favicons/swc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-196x196.png to #> favicons/swc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-32x32.png to #> favicons/swc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-96x96.png to #> favicons/swc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon.ico to #> favicons/swc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-144x144.png to #> favicons/swc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-150x150.png to #> favicons/swc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x150.png to #> favicons/swc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x310.png to #> favicons/swc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-70x70.png to #> favicons/swc/mstile-70x70.png #> Copying <varnish>/pkgdown/assets/mstile-150x150.png to #> mstile-150x150.png #> Copying <varnish>/pkgdown/assets/safari-pinned-tab.svg to #> safari-pinned-tab.svg #> Copying <varnish>/pkgdown/assets/site.webmanifest to site.webmanifest cli::cli_h2(\"git status: {gert::git_branch(repo = res)}\") #> #> ── git status: main ── #> print(gert::git_status(repo = res)) #> # A tibble: 0 × 3 #> # ℹ 3 variables: file <chr>, status <chr>, staged <lgl> cli::cli_h2('git status: {gert::git_branch(repo = fs::path(res, \"site\", \"built\"))}') #> ── git status: md-outputs ── #> print(gert::git_status(repo = fs::path(res, \"site\", \"built\"))) #> # A tibble: 13 × 3 #> file status staged #> <chr> <chr> <lgl> #> 1 CODE_OF_CONDUCT.md new FALSE #> 2 LICENSE.md new FALSE #> 3 config.yaml new FALSE #> 4 fig/ new FALSE #> 5 index.md new FALSE #> 6 instructor-notes.md new FALSE #> 7 introduction.md new FALSE #> 8 learner-profiles.md new FALSE #> 9 links.md new FALSE #> 10 md5sum.txt new FALSE #> 11 reference.md new FALSE #> 12 renv.lock new FALSE #> 13 setup.md new FALSE cli::cli_h2('git status: {gert::git_branch(repo = fs::path(res, \"site\", \"docs\"))}') #> ── git status: gh-pages ── #> print(gert::git_status(repo = fs::path(res, \"site\", \"docs\"))) #> # A tibble: 36 × 3 #> file status staged #> <chr> <chr> <lgl> #> 1 .nojekyll new FALSE #> 2 404.html new FALSE #> 3 CODE_OF_CONDUCT.html new FALSE #> 4 LICENSE.html new FALSE #> 5 aio.html new FALSE #> 6 android-chrome-192x192.png new FALSE #> 7 android-chrome-512x512.png new FALSE #> 8 apple-touch-icon.png new FALSE #> 9 assets/ new FALSE #> 10 bootstrap-toc.css new FALSE #> # ℹ 26 more rows tok <- Sys.time() cli::cli_alert_info(\"Elapsed time: {round(tok - tik, 2)} seconds\") #> ℹ Elapsed time: 10.89 seconds tik <- Sys.time() cli::cli_h1(\"Clean Up\") #> #> ── Clean Up ──────────────────────────────────────────────────────────── cli::cli_alert_info(\"object db is an expression that evaluates to {.code {db}}\") #> ℹ object db is an expression that evaluates to `sandpaper:::github_worktree_remove(\"/tmp/RtmpD6AhNE/file16ef10cfa90b/lesson-example/site/built\", \"/tmp/RtmpD6AhNE/file16ef10cfa90b/lesson-example\")` eval(db) #> Running git worktree remove --force \\ #> /tmp/RtmpD6AhNE/file16ef10cfa90b/lesson-example/site/built #> $status #> [1] 0 #> #> $stdout #> [1] \"\" #> #> $stderr #> [1] \"\" #> #> $timeout #> [1] FALSE #> cli::cli_alert_info(\"object ds is an expression that evaluates to {.code {ds}}\") #> ℹ object ds is an expression that evaluates to `sandpaper:::github_worktree_remove(\"/tmp/RtmpD6AhNE/file16ef10cfa90b/lesson-example/site/docs\", \"/tmp/RtmpD6AhNE/file16ef10cfa90b/lesson-example\")` eval(ds) #> Running git worktree remove --force \\ #> /tmp/RtmpD6AhNE/file16ef10cfa90b/lesson-example/site/docs #> $status #> [1] 0 #> #> $stdout #> [1] \"\" #> #> $stderr #> [1] \"\" #> #> $timeout #> [1] FALSE #> sandpaper:::remove_local_remote(repo = res) #> ℹ removing 'sandpaper-local' (/tmp/RtmpD6AhNE/REMOTE-16ef41fc2832) #> /tmp/RtmpD6AhNE/REMOTE-16ef41fc2832 sandpaper:::reset_git_user(res) # remove the test fixture and report tryCatch(fs::dir_delete(res), error = function() FALSE) tok <- Sys.time() cli::cli_alert_info(\"Elapsed time: {round(tok - tik, 2)} seconds\") #> ℹ Elapsed time: 0.14 seconds"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/hash_children.html","id":null,"dir":"Reference","previous_headings":"","what":"Update file checksums to account for child documents — hash_children","title":"Update file checksums to account for child documents — hash_children","text":"R Markdown file contains child document, hash replaced hash combined unnamed hashes parent descendants (aka lineage).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/hash_children.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update file checksums to account for child documents — hash_children","text":"","code":"hash_children(checksums, files, lineage) get_lineages(lsn)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/hash_children.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update file checksums to account for child documents — hash_children","text":"checksums hashes parent files files relative path parent files root_path lineage named list character vectors specifying absolute paths full lineage parent Markdown R Markdown files (inclusive). names relative path parent. lsn pegboard::Lesson object","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/hash_children.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update file checksums to account for child documents — hash_children","text":"get_lineages() named list charcter vectors specifying lineage parent files. names relative paths parents. hash_children() character vector hashes length parent files.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/hash_children.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Update file checksums to account for child documents — hash_children","text":"handling child files lessons, important changes child files cause source file change well. get_lineages() function finds child files pegboard::Lesson object. use text database relies hash file determine file rebuilt, hash_children() piggybacks paradigm assigning unique hash parent file children hash vector hashes files. hash hashes created rlang::hash().","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/hash_children.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Update file checksums to account for child documents — hash_children","text":"","code":"# This demonstration will show how a temporary database can be set up. It # will only work with a sandpaper lesson # setup ----------------------------------------------------------------- # The setup needs to include an R Markdown file with a child file. tmp <- tempfile() on.exit(fs::dir_delete(tmp), add = TRUE) #> Error: [ENOENT] Failed to search directory '/tmp/RtmpD6AhNE/file16ef72c44e0b': no such file or directory create_lesson(tmp, rmd = FALSE, open = FALSE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef72c44e0b... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef72c44e0b... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef72c44e0b... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef72c44e0b... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef72c44e0b... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef72c44e0b/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef72c44e0b... #> ✔ First episode created in /tmp/RtmpD6AhNE/file16ef72c44e0b/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef72c44e0b... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef72c44e0b... #> ✔ Lesson successfully created in /tmp/RtmpD6AhNE/file16ef72c44e0b #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef72c44e0b... #> /tmp/RtmpD6AhNE/file16ef72c44e0b # get namespace to use internal functions sp <- asNamespace(\"sandpaper\") db <- fs::path(tmp, \"site/built/md5sum.txt\") resources <- fs::path(tmp, c(\"episodes/introduction.md\", \"index.md\")) # create child file writeLines(\"Hello from another file!\\n\", fs::path(tmp, \"episodes\", \"files\", \"hi.md\")) # use child file cat(\"\\n\\n```{r child='files/hi.md'}\\n```\\n\", file = resources[[1]], append = TRUE) # convert to Rmd fs::file_move(resources[[1]], fs::path_ext_set(resources[[1]], \"Rmd\")) resources[[1]] <- fs::path_ext_set(resources[[1]], \"Rmd\") set_episodes(tmp, fs::path_file(resources[[1]]), write = TRUE) # get_lineages ------------------------------------------------------ # we can get the child files by scanning the Lesson object lsn <- sp$this_lesson(tmp) class(lsn) #> [1] \"Lesson\" \"R6\" children <- sp$get_lineages(lsn) print(children) #> $`episodes/introduction.Rmd` #> [1] \"/tmp/RtmpD6AhNE/file16ef72c44e0b/episodes/introduction.Rmd\" #> [2] \"/tmp/RtmpD6AhNE/file16ef72c44e0b/episodes/files/hi.md\" #> #> $CODE_OF_CONDUCT.md #> /tmp/RtmpD6AhNE/file16ef72c44e0b/CODE_OF_CONDUCT.md #> #> $CONTRIBUTING.md #> /tmp/RtmpD6AhNE/file16ef72c44e0b/CONTRIBUTING.md #> #> $LICENSE.md #> /tmp/RtmpD6AhNE/file16ef72c44e0b/LICENSE.md #> #> $README.md #> /tmp/RtmpD6AhNE/file16ef72c44e0b/README.md #> #> $index.md #> /tmp/RtmpD6AhNE/file16ef72c44e0b/index.md #> #> $links.md #> /tmp/RtmpD6AhNE/file16ef72c44e0b/links.md #> #> $`instructors/instructor-notes.md` #> /tmp/RtmpD6AhNE/file16ef72c44e0b/instructors/instructor-notes.md #> #> $`learners/reference.md` #> /tmp/RtmpD6AhNE/file16ef72c44e0b/learners/reference.md #> #> $`learners/setup.md` #> /tmp/RtmpD6AhNE/file16ef72c44e0b/learners/setup.md #> #> $`profiles/learner-profiles.md` #> /tmp/RtmpD6AhNE/file16ef72c44e0b/profiles/learner-profiles.md #> # hash_children --------------------------------------------------- # get hash of parent phash <- tools::md5sum(resources[[1]]) rel_parent <- fs::path_rel(resources[[1]], start = tmp) sp$hash_children(phash, rel_parent, children) #> episodes/introduction.Rmd #> \"f0803606fb41fb5ba9d03df618d492ae\" # demonstrate how this works ---------------- # the combined hashes have their names removed and then `rlang::hash()` # creates the hash of the unnamed hashes. chash <- tools::md5sum(children[[1]]) hashes <- unname(chash) print(hashes) #> [1] \"4c6b9769ec953e27d83c6c707d549b82\" #> [2] \"a649c757324fc9c289e38f3d77c206d5\" rlang::hash(hashes) #> [1] \"f0803606fb41fb5ba9d03df618d492ae\""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/known_languages.html","id":null,"dir":"Reference","previous_headings":"","what":"Show a list of languages known by {sandpaper} — known_languages","title":"Show a list of languages known by {sandpaper} — known_languages","text":"Show list languages known {sandpaper}","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/known_languages.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Show a list of languages known by {sandpaper} — known_languages","text":"","code":"known_languages()"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/known_languages.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Show a list of languages known by {sandpaper} — known_languages","text":"character vector language codes known {sandpaper}","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/known_languages.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Show a list of languages known by {sandpaper} — known_languages","text":"known languages translations menu navigational elements exist {sandpaper}. elements translated given language like add translations , please consult vignette(\"translations\", package = \"sandpaper\") details source code {sandpaper}.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/known_languages.html","id":"list-of-known-languages-","dir":"Reference","previous_headings":"","what":"List of Known Languages:","title":"Show a list of languages known by {sandpaper} — known_languages","text":"","code":"#> - en #> - es #> - fr #> - ja #> - uk"},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/known_languages.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Show a list of languages known by {sandpaper} — known_languages","text":"","code":"known_languages() #> [1] \"en\" \"de\" \"es\" \"fr\" \"ja\" \"uk\""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/lesson_storage.html","id":null,"dir":"Reference","previous_headings":"","what":"Internal cache for storing pre-computed lesson objects — this_lesson","title":"Internal cache for storing pre-computed lesson objects — this_lesson","text":"storage cache pegboard::Lesson objects pre-computed items use internal functions {sandpaper} working.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/lesson_storage.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Internal cache for storing pre-computed lesson objects — this_lesson","text":"","code":"this_lesson(path) clear_this_lesson() set_this_lesson(path) set_resource_list(path) clear_resource_list(path)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/lesson_storage.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Internal cache for storing pre-computed lesson objects — this_lesson","text":"path path current lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/lesson_storage.html","id":"lesson-object-storage","dir":"Reference","previous_headings":"","what":"Lesson Object Storage","title":"Internal cache for storing pre-computed lesson objects — this_lesson","text":"this_lesson() return pegboard::Lesson object previously stored. three values cached: .this_lesson pegboard::Lesson object .this_diff charcter vector gert::git_diff_patch() .this_status data frame gert::git_status() .this_commit hash recent commit function this_lesson() first checks .this_diff different output gert::git_diff_patch(), checks changes gert::git_status(), finally checks commits identical. differences values previously cached, lesson loaded memory, otherwise, fetched previously stored lesson. storage cache global package object called .store, initialised {sandpaper} loaded via .lesson_store() changes git aware , lesson remains .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/lesson_storage.html","id":"pre-computed-object-storage","dir":"Reference","previous_headings":"","what":"Pre-Computed Object Storage","title":"Internal cache for storing pre-computed lesson objects — this_lesson","text":"side-effect this_lesson() also initialise pre-computed objects pertain lesson . initialised via set_globals(). storage objects : .resources: list markdown resources lesson derived get_resource_list() via set_resource_list() this_metadata: metadata template including pages. initialised initialise_metadata() via set_globals() learner_globals: variables learner version pages initialised set_globals() instructor_globals: variables instructor version pages initialised set_globals()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/lesson_storage.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Internal cache for storing pre-computed lesson objects — this_lesson","text":"","code":"tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef30c44122... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef30c44122... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef30c44122... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef30c44122... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef30c44122... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef30c44122/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef30c44122... #> ✔ First episode created in /tmp/RtmpD6AhNE/file16ef30c44122/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef30c44122... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef30c44122... #> ✔ Lesson successfully created in /tmp/RtmpD6AhNE/file16ef30c44122 #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef30c44122... #> /tmp/RtmpD6AhNE/file16ef30c44122 # Read the lesson into cache system.time(sandpaper:::this_lesson(tmp)) #> user system elapsed #> 0.127 0.000 0.128 system.time(sandpaper:::this_lesson(tmp)) # less time to read in once cached #> user system elapsed #> 0.000 0.004 0.003 l <- sandpaper:::this_lesson(tmp) l #> <Lesson> #> Public: #> blocks: function (type = NULL, level = 0, path = FALSE) #> built: NULL #> challenges: function (path = FALSE, graph = FALSE, recurse = TRUE) #> children: NULL #> clone: function (deep = FALSE) #> episodes: list #> extra: list #> files: active binding #> get: function (element = NULL, collection = \"episodes\") #> handout: function (path = NULL, solution = FALSE) #> has_children: active binding #> initialize: function (path = \".\", rmd = FALSE, jekyll = TRUE, ...) #> isolate_blocks: function () #> load_built: function () #> n_problems: active binding #> overview: FALSE #> path: /tmp/RtmpD6AhNE/file16ef30c44122 #> reset: function () #> rmd: FALSE #> sandpaper: TRUE #> show_problems: active binding #> solutions: function (path = FALSE) #> summary: function (collection = \"episodes\") #> thin: function (verbose = TRUE) #> trace_lineage: function (episode_path) #> validate_divs: function () #> validate_headings: function (verbose = TRUE) #> validate_links: function () #> Private: #> deep_clone: function (name, value) # clear the cache sandpaper:::clear_this_lesson() system.time(sandpaper:::this_lesson(tmp)) # have to re-read the lesson #> user system elapsed #> 0.113 0.016 0.129 system.time(sandpaper:::this_lesson(tmp)) #> user system elapsed #> 0.001 0.004 0.005 unlink(tmp)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_aio_section.html","id":null,"dir":"Reference","previous_headings":"","what":"Make a section and place it inside the All In One page — make_aio_section","title":"Make a section and place it inside the All In One page — make_aio_section","text":"episode needs added AiO, insert XML nodes episode contents section inside One page.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_aio_section.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Make a section and place it inside the All In One page — make_aio_section","text":"","code":"make_aio_section(name, contents, parent)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_aio_section.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Make a section and place it inside the All In One page — make_aio_section","text":"name name section, prefixed episode- contents episode contents get_content() parent parent div AiO page.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_aio_section.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Make a section and place it inside the All In One page — make_aio_section","text":"section added parent","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_aio_section.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Make a section and place it inside the All In One page — make_aio_section","text":"","code":"if (FALSE) { lsn <- \"/path/to/lesson\" pkg <- pkgdown::as_pkgdown(fs::path(lsn, \"site\")) # read in the All in One page and extract its content aio <- get_content(\"aio\", content = \"self::*\", pkg = pkg) episode_content <- get_content(\"01-introduction\", pkg = pkg) make_aio_section(\"aio-01-introduction\", contents = episode_content, parent = aio ) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_images_section.html","id":null,"dir":"Reference","previous_headings":"","what":"Make a section of aggregated images — make_images_section","title":"Make a section of aggregated images — make_images_section","text":"insert xml figure nodes images page, printing alt text descriptions users using screen readers.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_images_section.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Make a section of aggregated images — make_images_section","text":"","code":"make_images_section(name, contents, parent)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_images_section.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Make a section of aggregated images — make_images_section","text":"name name section, (may may prefixed images-) contents xml_nodeset figure elements get_content() parent parent div images page","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_images_section.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Make a section of aggregated images — make_images_section","text":"section added parent","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_images_section.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Make a section of aggregated images — make_images_section","text":"","code":"if (FALSE) { lsn <- \"/path/to/lesson\" pkg <- pkgdown::as_pkgdown(fs::path(lsn, \"site\")) # read in the All in One page and extract its content img <- get_content(\"images\", content = \"self::*\", pkg = pkg) fig_content <- get_content(\"01-introduction\", content = \"/figure\", pkg = pkg) make_images_section(\"01-introduction\", contents = fig_content, parent = img) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_instructornotes_section.html","id":null,"dir":"Reference","previous_headings":"","what":"Make a section of aggregated instructor notes — make_instructornotes_section","title":"Make a section of aggregated instructor notes — make_instructornotes_section","text":"append instructor notes inline sections lesson instructor-notes page, separated section <hr> elements.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_instructornotes_section.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Make a section of aggregated instructor notes — make_instructornotes_section","text":"","code":"make_instructornotes_section(name, contents, parent)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_instructornotes_section.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Make a section of aggregated instructor notes — make_instructornotes_section","text":"name name section, (may may prefixed images-) contents xml_nodeset figure elements get_content() parent parent div images page","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_instructornotes_section.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Make a section of aggregated instructor notes — make_instructornotes_section","text":"section added parent","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_instructornotes_section.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Make a section of aggregated instructor notes — make_instructornotes_section","text":"learner view, instructor notes present","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_instructornotes_section.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Make a section of aggregated instructor notes — make_instructornotes_section","text":"","code":"if (FALSE) { lsn <- \"/path/to/lesson\" pkg <- pkgdown::as_pkgdown(fs::path(lsn, \"site\")) # read in the All in One page and extract its content notes <- get_content(\"instructor-notes\", content = \"section[@id='aggregate-instructor-notes']\", pkg = pkg, instructor = TRUE ) agg <- \"/div[contains(@class, 'instructor-note')]//div[@class='accordion-body']\" note_content <- get_content(\"01-introduction\", content = agg, pkg = pkg) make_instructornotes_section(\"01-introduction\", contents = note_content, parent = notes ) # NOTE: if the object for \"contents\" ends with \"_learn\", no content will be # appended note_learn <- note_content make_instructornotes_section(\"01-introduction\", contents = note_learn, parent = notes ) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/move_episode.html","id":null,"dir":"Reference","previous_headings":"","what":"Move an episode in the schedule — move_episode","title":"Move an episode in the schedule — move_episode","text":"need move single episode, function gives programmatic interactive interface accomplishing task, whether need add episode, draft, remove episode schedule.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/move_episode.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Move an episode in the schedule — move_episode","text":"","code":"move_episode(ep = NULL, position = NULL, write = FALSE, path = \".\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/move_episode.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Move an episode in the schedule — move_episode","text":"ep name draft episode name/number published episode move. position position schedule move episode. Valid positions 0 number episodes (+1 drafts). value 0 indicates episode removed schedule. write defaults FALSE, show potential changes. TRUE, schedule modified written config.yaml path path lesson (defaults current working directory)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/move_episode.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Move an episode in the schedule — move_episode","text":"","code":"if (interactive() || Sys.getenv(\"CI\") != \"\") { tmp <- tempfile() create_lesson(tmp) create_episode_md(\"getting-started\", path = tmp, open = FALSE) create_episode_rmd(\"plotting\", path = tmp, open = FALSE) create_episode_md(\"experimental\", path = tmp, add = FALSE, open = FALSE) set_episodes(tmp, c(\"getting-started.md\", \"introduction.Rmd\", \"plotting.Rmd\"), write = TRUE) # Default episode order is alphabetical, we can use this to nudge episodes get_episodes(tmp) move_episode(\"introduction.Rmd\", 1L, path = tmp) # by default, it shows you the change move_episode(\"introduction.Rmd\", 1L, write = TRUE, path = tmp) # write the results get_episodes(tmp) # Add episodes from the drafts get_drafts(tmp) move_episode(\"experimental.md\", 2L, path = tmp) # view where it will live move_episode(\"experimental.md\", 2L, write = TRUE, path = tmp) get_episodes(tmp) # Unpublish episodes by setting position to zero move_episode(\"experimental.md\", 0L, path = tmp) # view the results move_episode(\"experimental.md\", 0L, write = TRUE, path = tmp) get_episodes(tmp) # Interactively select the position where the episode should go by omitting # the position argument if (interactive()) { move_episode(\"experimental.md\", path = tmp) } } #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef46000595... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef46000595... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef46000595... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef46000595... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef46000595... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef46000595/episodes/introduction.Rmd. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef46000595... #> ✔ First episode created in /tmp/RtmpD6AhNE/file16ef46000595/episodes/introduction.Rmd #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef46000595... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef46000595... #> ℹ Consent to use package cache provided #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef46000595... #> - The project is out-of-sync -- use `renv::status()` for details. #> → Searching for and installing available dependencies #> The following packages were discovered: #> #> # ~/work/_temp/Library ------------------------------------------------------- #> - R6 2.5.1 #> - base64enc 0.1-3 #> - bslib 0.8.0 #> - cachem 1.1.0 #> - cli 3.6.3 #> - digest 0.6.37 #> - evaluate 1.0.1 #> - fastmap 1.2.0 #> - fontawesome 0.5.2 #> - fs 1.6.4 #> - glue 1.8.0 #> - highr 0.11 #> - htmltools 0.5.8.1 #> - jquerylib 0.1.4 #> - jsonlite 1.8.9 #> - knitr 1.48 #> - lifecycle 1.0.4 #> - memoise 2.0.1 #> - mime 0.12 #> - rappdirs 0.3.3 #> - rlang 1.1.4 #> - rmarkdown 2.28 #> - sass 0.4.9 #> - tinytex 0.53 #> - xfun 0.48 #> - yaml 2.3.10 #> #> They will be copied into the project library. #> #> - Copying packages into the project library ... Done! #> - Hydrated 26 packages in 0.21 seconds. #> - The project is out-of-sync -- use `renv::status()` for details. #> → Recording changes in lockfile #> The following package(s) will be updated in the lockfile: #> #> # https://packagemanager.posit.co/cran/__linux__/jammy/latest ---------------- #> - R6 [* -> 2.5.1] #> - base64enc [* -> 0.1-3] #> - bslib [* -> 0.8.0] #> - cachem [* -> 1.1.0] #> - cli [* -> 3.6.3] #> - digest [* -> 0.6.37] #> - evaluate [* -> 1.0.1] #> - fastmap [* -> 1.2.0] #> - fontawesome [* -> 0.5.2] #> - fs [* -> 1.6.4] #> - glue [* -> 1.8.0] #> - highr [* -> 0.11] #> - htmltools [* -> 0.5.8.1] #> - jquerylib [* -> 0.1.4] #> - jsonlite [* -> 1.8.9] #> - knitr [* -> 1.48] #> - lifecycle [* -> 1.0.4] #> - memoise [* -> 2.0.1] #> - mime [* -> 0.12] #> - rappdirs [* -> 0.3.3] #> - renv [* -> 1.0.11] #> - rlang [* -> 1.1.4] #> - rmarkdown [* -> 2.28] #> - sass [* -> 0.4.9] #> - tinytex [* -> 0.53] #> - xfun [* -> 0.48] #> - yaml [* -> 2.3.10] #> #> The version of R recorded in the lockfile will be updated: #> - R [* -> 4.4.1] #> #> - Lockfile written to \"/tmp/RtmpD6AhNE/file16ef46000595/renv/profiles/lesson-requirements/renv.lock\". #> ✔ Lesson successfully created in /tmp/RtmpD6AhNE/file16ef46000595 #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef46000595... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef46000595/episodes/getting-started.md. #> ☐ Edit /tmp/RtmpD6AhNE/file16ef46000595/episodes/plotting.Rmd. #> ☐ Edit /tmp/RtmpD6AhNE/file16ef46000595/episodes/experimental.md. #> episodes: #> - introduction.Rmd #> - getting-started.md #> - plotting.Rmd #> #> ──────────────────────────────────────────────────────────────────────── #> ℹ To save this configuration, use #> #> move_episode(ep = \"introduction.Rmd\", position = 1, path = tmp, write = TRUE) #> ℹ Files are in draft: episodes/experimental.md #> ℹ All files in learners/ published (config.yaml empty) #> ℹ All files in instructors/ published (config.yaml empty) #> ℹ All files in profiles/ published (config.yaml empty) #> episodes: #> - introduction.Rmd #> - experimental.md #> - getting-started.md #> - plotting.Rmd #> #> ──────────────────────────────────────────────────────────────────────── #> ℹ To save this configuration, use #> #> move_episode(ep = \"experimental.md\", position = 2, path = tmp, write = TRUE) #> episodes: #> - introduction.Rmd #> - getting-started.md #> - plotting.Rmd #> #> ── Removed episodes ──────────────────────────────────────────────────── #> - experimental.md #> ──────────────────────────────────────────────────────────────────────── #> ℹ To save this configuration, use #> #> move_episode(ep = \"experimental.md\", position = 0, path = tmp, write = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":null,"dir":"Reference","previous_headings":"","what":"Give Consent to Use Package Cache — use_package_cache","title":"Give Consent to Use Package Cache — use_package_cache","text":"functions explicitly gives sandpaper permission use renv create package cache future lessons. two states can use: use_package_cache(): Gives explicit permission set use package cache lesson. no_package_cache(): Temporarily suspends permission use package cache lesson, regardless previously given. package cache defined, can use changes lockfile trigger rebuilds lesson. , can use: package_cache_trigger(TRUE) function best used conjunction update_cache()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Give Consent to Use Package Cache — use_package_cache","text":"","code":"use_package_cache(prompt = interactive(), quiet = !prompt) no_package_cache() package_cache_trigger(rebuild = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Give Consent to Use Package Cache — use_package_cache","text":"prompt TRUE (default interactive), prompt consent giving information proposed modifications appear screen asking user choose apply changes . quiet TRUE, messages issued unless prompt = TRUE. defaults opposite prompt. rebuild new value sandpaper.package_cache_trigger global option. Setting TRUE result materials rebuilt new records enter package cache lockfile even source files changed. Setting FALSE return default state, rebuld source files changed. default NULL, nothing.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Give Consent to Use Package Cache — use_package_cache","text":"nothing. used side-effect value getOption(\"sandpaper.package_cache_trigger\") FALSE, unset.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"background","dir":"Reference","previous_headings":"","what":"Background","title":"Give Consent to Use Package Cache — use_package_cache","text":"default, sandpaper happily build lesson using packages available default R library, can undesirable couple reasons: may different version lesson package used lesson website, may result strange errors, warnings, incorrect output. might cautious updating components current R infrastructure work depends correct package versions installed. alleviate concerns, sandpaper uses renv package generate lesson-specific library package versions pinned lesson authors choose update . designed minimally-invasive, using packages already downloading external repositories necessary.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"what-if-i-have-used-renv-before-","dir":"Reference","previous_headings":"","what":"What if I have used renv before?","title":"Give Consent to Use Package Cache — use_package_cache","text":"used renv past, need give consent use cache.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"how-do-i-turn-off-the-feature-temporarily-","dir":"Reference","previous_headings":"","what":"How do I turn off the feature temporarily?","title":"Give Consent to Use Package Cache — use_package_cache","text":"turn feature can use no_package_cache(). sandpaper respect option building lesson use global library instead.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"i-have-used-renv-before-how-do-i-turn-it-off-before-sandpaper-loads-","dir":"Reference","previous_headings":"","what":"I have used renv before; how do I turn it off before sandpaper loads?","title":"Give Consent to Use Package Cache — use_package_cache","text":"can set options(sandpaper.use_renv = FALSE) loading {sandpaper}.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Give Consent to Use Package Cache — use_package_cache","text":"","code":"if (!getOption(\"sandpaper.use_renv\") && interactive()) { # The first time you set up `{renv}`, you will need permission use_package_cache(prompt = TRUE) # The package cache trigger is FALSE, by default default <- package_cache_trigger() # You can set this to `TRUE` when you update packages with `update_cache()` package_cache_trigger(TRUE) # set the trigger back to its former state package_cache_trigger(default) } if (getOption(\"sandpaper.use_renv\") && interactive()) { # If you have previously used `{renv}`, permission is implied use_package_cache(prompt = TRUE) # You can temporarily turn this off no_package_cache() getOption(\"sandpaper.use_renv\") # should be FALSE use_package_cache(prompt = TRUE) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/parse_file_matches.html","id":null,"dir":"Reference","previous_headings":"","what":"Subset file matches to the order they appear in the config file — parse_file_matches","title":"Subset file matches to the order they appear in the config file — parse_file_matches","text":"Subset file matches order appear config file","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/parse_file_matches.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Subset file matches to the order they appear in the config file — parse_file_matches","text":"","code":"parse_file_matches(reality, hopes = NULL, warn = FALSE, subfolder)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/parse_file_matches.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Subset file matches to the order they appear in the config file — parse_file_matches","text":"reality list paths exist lesson hopes list files order appear lesson warn boolean. TRUE sandpaper.show_draft option set TRUE, files hopes shown screen drafts subfolder character. folder find files hopes. used creating error message.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/parse_file_matches.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Subset file matches to the order they appear in the config file — parse_file_matches","text":"character vector reality subset order hopes","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/parse_file_matches.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Subset file matches to the order they appear in the config file — parse_file_matches","text":"","code":"# setup ---------------------------------------------------- # # NOTE: we need to define our namespace here because using `:::` # in example calls is illegal. snd <- asNamespace(\"sandpaper\") print(need <- c(\"a\", \"bunch\", \"of\", \"silly\", \"files\")) #> [1] \"a\" \"bunch\" \"of\" \"silly\" \"files\" print(exists <- fs::path(\"path\", \"to\", sample(need))) #> path/to/a path/to/bunch path/to/of path/to/silly path/to/files # Rearrange files ------------------------------------------ snd$parse_file_matches(reality = exists, hopes = need, subfolder = \"episodes\") #> path/to/a path/to/bunch path/to/of path/to/silly path/to/files # a subset of files ---------------------------------------- snd$parse_file_matches(reality = exists, hopes = need[4:5], subfolder = \"episodes\") #> path/to/silly path/to/files # a subset of files with a warning ------------------------- op <- getOption(\"sandpaper.show_draft\") options(sandpaper.show_draft = TRUE) on.exit(options(sandpaper.show_draft = op)) snd$parse_file_matches(reality = exists, hopes = need[-(4:5)], warn = TRUE, subfolder = \"episodes\") #> path/to/a path/to/bunch path/to/of # files that do not exist give an error -------------------- try(snd$parse_file_matches(reality = exists, hopes = c(\"these\", need[4:5]), subfolder = \"episodes\")) #> episodes: #> - ✖ these #> - silly #> - files #> Error in error_missing_config(hopes, real_files, subfolder) : #> All files in config.yaml must exist #> • Files marked with ✖ are not present"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/provision.html","id":null,"dir":"Reference","previous_headings":"","what":"Provision an aggregate page in a lesson — provision_agg_page","title":"Provision an aggregate page in a lesson — provision_agg_page","text":"function provision page using reusable template provisioned aggregate pages used lesson avoid unnecessary re-rendering already rendered content.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/provision.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Provision an aggregate page in a lesson — provision_agg_page","text":"","code":"provision_agg_page(pkg, title = \"Key Points\", slug = \"key-points\", new = FALSE) provision_extra_template(pkg, quiet = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/provision.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Provision an aggregate page in a lesson — provision_agg_page","text":"pkg object created via pkgdown::as_pkgdown() lesson. title new page title slug slug page (e.g. \"aio\" become \"aio.html\") new TRUE, (default), page generated new template. FALSE, page assumed pre-built appended .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/provision.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Provision an aggregate page in a lesson — provision_agg_page","text":"provision_agg_page(): list: $learner: xml_document templated learner page $instructor: xml_document templated instructor page $needs_episodes: logical indicating page completly rebuilt (currently default TRUE) provision_extra_template(): invisibly, copy global list HTML template content available internal global object sandpaper:::.html: .html$template$extra$learner: rendered learner template string .html$template$extra$instructor: rendered instructor template string","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/provision.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Provision an aggregate page in a lesson — provision_agg_page","text":"Pkgdown provides lot services rendering: cross-linking syntax highlighting dynamic templating etc. problem effort takes time scales size page rendered cases can take ~2 seconds One page small lesson. Creating aggregate pages markdown content rendered involve re-rendering content. Luckily, reading content xml2::read_html() quick using XPath queries, can take parts need rendered content insert template, store character .html global object can passed around functions without needing argument. provision_agg_page() makes copy cache, replaces FIXME values appropriate elements, returns object created xml2::read_html() instructor learner veiws.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/provision.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Provision an aggregate page in a lesson — provision_agg_page","text":"","code":"if (FALSE) { # only run if you have provisioned a pkgdown site lsn_site <- \"/path/to/lesson/site\" pkg <- pkgdown::as_pkgdown(lsn_site) # create an AIO page provision_agg_page(pkg, title = \"All In One\", slug = \"aio\", quiet = FALSE) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/read_all_html.html","id":null,"dir":"Reference","previous_headings":"","what":"read all HTML files in a folder — read_all_html","title":"read all HTML files in a folder — read_all_html","text":"read HTML files folder","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/read_all_html.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"read all HTML files in a folder — read_all_html","text":"","code":"read_all_html(path)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/read_all_html.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"read all HTML files in a folder — read_all_html","text":"path path folder HTML files","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/read_all_html.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"read all HTML files in a folder — read_all_html","text":"nested list html_documents xml2::read_html() two top-level elements: $learner: contains html pages learner view $instructor: pages instructor view $paths: absolute paths pages","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/read_all_html.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"read all HTML files in a folder — read_all_html","text":"","code":"tmpdir <- tempfile() on.exit(fs::dir_delete(tmpdir)) #> Error: [ENOENT] Failed to search directory '/tmp/RtmpD6AhNE/file16ef7a459143': no such file or directory fs::dir_create(tmpdir) fs::dir_create(fs::path(tmpdir, \"instructor\")) writeLines(\"<p>Instructor<\/p>\", fs::path(tmpdir, \"instructor\", \"index.html\")) writeLines(\"<p>Learner<\/p>\", fs::path(tmpdir, \"index.html\")) sandpaper:::read_all_html(tmpdir) #> $instructor #> $instructor$index #> {html_document} #> <html> #> [1] <body><p>Instructor<\/p><\/body> #> #> #> $learner #> $learner$index #> {html_document} #> <html> #> [1] <body><p>Learner<\/p><\/body> #> #> #> $paths #> /tmp/RtmpD6AhNE/file16ef7a459143/index.html #> /tmp/RtmpD6AhNE/file16ef7a459143/instructor/index.html #>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/render_html.html","id":null,"dir":"Reference","previous_headings":"","what":"Render html from a markdown file — render_html","title":"Render html from a markdown file — render_html","text":"uses rmarkdown::pandoc_convert() render HTML markdown file. specified pandoc extensions align features desired Carpentries markdown_in_html_blocks, tex_math_dollars, native_divs.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/render_html.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Render html from a markdown file — render_html","text":"","code":"render_html(path_in, ..., quiet = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/render_html.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Render html from a markdown file — render_html","text":"path_in path markdown file ... extra options (e.g. lua filters) passed pandoc quiet TRUE, output produced. Default FALSE, reports markdown build via pandoc","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/render_html.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Render html from a markdown file — render_html","text":"character containing rendred HTML file","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/render_html.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Render html from a markdown file — render_html","text":"","code":"if (rmarkdown::pandoc_available(\"2.11\")) { # first example---markdown to HTML tmp <- tempfile() ex <- c(\"# Markdown\", \"\", \"::: challenge\", \"\", \"How do you write markdown divs?\", \"\", \":::\" ) writeLines(ex, tmp) cat(sandpaper:::render_html(tmp)) # adding a lua filter lua <- tempfile() lu <- c(\"Str = function (elem)\", \" if elem.text == 'markdown' then\", \" return pandoc.Emph {pandoc.Str 'mowdrank'}\", \" end\", \"end\") writeLines(lu, lua) lf <- paste0(\"--lua-filter=\", lua) cat(sandpaper:::render_html(tmp, lf)) } #> <div id=\"markdown\" class=\"section level1\"> #> <h1>Markdown<\/h1> #> <div id=\"discussion1\" class=\"callout discussion\"> #> <div class=\"callout-square\"> #> <i class='callout-icon' data-feather='message-circle'><\/i> #> <\/div> #> <div class=\"section level3 callout-title callout-inner\"> #> <h3 class=\"callout-title\">Challenge<\/h3> #> <div class=\"callout-content\"> #> <p>How do you write markdown divs?<\/p> #> <\/div> #> <\/div> #> <\/div> #> <\/div><div id=\"markdown\" class=\"section level1\"> #> <h1>Markdown<\/h1> #> <div id=\"discussion1\" class=\"callout discussion\"> #> <div class=\"callout-square\"> #> <i class='callout-icon' data-feather='message-circle'><\/i> #> <\/div> #> <div class=\"section level3 callout-title callout-inner\"> #> <h3 class=\"callout-title\">Challenge<\/h3> #> <div class=\"callout-content\"> #> <p>How do you write <em>mowdrank<\/em> divs?<\/p> #> <\/div> #> <\/div> #> <\/div> #> <\/div>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/renv_diagnostics.html","id":null,"dir":"Reference","previous_headings":"","what":"Print a diagnostics report for the package cache — renv_diagnostics","title":"Print a diagnostics report for the package cache — renv_diagnostics","text":"Print diagnostics report package cache","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/renv_diagnostics.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Print a diagnostics report for the package cache — renv_diagnostics","text":"","code":"renv_diagnostics(path = \".\", profile = \"lesson-requirements\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/renv_diagnostics.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Print a diagnostics report for the package cache — renv_diagnostics","text":"path path lesson use diagnostics profile profile work (defaults \"lesson-requirements\"","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/renv_lockfile_hash.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the hash for the previous and current lockfile (as recorded in the lesson) — renv_lockfile_hash","title":"Get the hash for the previous and current lockfile (as recorded in the lesson) — renv_lockfile_hash","text":"Get hash previous current lockfile (recorded lesson)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/renv_lockfile_hash.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the hash for the previous and current lockfile (as recorded in the lesson) — renv_lockfile_hash","text":"","code":"renv_lockfile_hash(path, db_path, profile = \"lesson-requirements\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/renv_lockfile_hash.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the hash for the previous and current lockfile (as recorded in the lesson) — renv_lockfile_hash","text":"path path lesson db_path path database profile name profile renv uses lesson requirements","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/renv_lockfile_hash.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the hash for the previous and current lockfile (as recorded in the lesson) — renv_lockfile_hash","text":"named list: old: hash value recoreded database new: hash value current file","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":null,"dir":"Reference","previous_headings":"","what":"Filter reserved markdown files from the built db — reserved_db","title":"Filter reserved markdown files from the built db — reserved_db","text":"provides service build_site() build files used aggregation, resource provision, GitHub specific files","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Filter reserved markdown files from the built db — reserved_db","text":"","code":"reserved_db(db)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Filter reserved markdown files from the built db — reserved_db","text":"db database get_built_db()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Filter reserved markdown files from the built db — reserved_db","text":"database files filtered ","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Filter reserved markdown files from the built db — reserved_db","text":"three types files reserved want propogate HTML site","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":"github-specific-files","dir":"Reference","previous_headings":"","what":"GitHub specific files","title":"Filter reserved markdown files from the built db — reserved_db","text":"README CONTRIBUTING files. files provide information useful context GitHub","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":"aggregation-files","dir":"Reference","previous_headings":"","what":"Aggregation files","title":"Filter reserved markdown files from the built db — reserved_db","text":"files aggregated together files content appended : index learners/setup concatenated markdown files profiles/ concatenated instructors/instructor-notes inline instructor notes concatenated.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":"resource-provision-files","dir":"Reference","previous_headings":"","what":"Resource provision files","title":"Filter reserved markdown files from the built db — reserved_db","text":"moment, one file use resource provision propogated site: links. provides global links lesson. provides content .","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_episodes.html","id":null,"dir":"Reference","previous_headings":"","what":"Clear the schedule in the lesson — reset_episodes","title":"Clear the schedule in the lesson — reset_episodes","text":"Clear schedule lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_episodes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clear the schedule in the lesson — reset_episodes","text":"","code":"reset_episodes(path = \".\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_episodes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clear the schedule in the lesson — reset_episodes","text":"path path lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_episodes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clear the schedule in the lesson — reset_episodes","text":"NULL, invisibly","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_episodes.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Clear the schedule in the lesson — reset_episodes","text":"","code":"tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef792514e8... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef792514e8... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef792514e8... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef792514e8... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef792514e8... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef792514e8/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef792514e8... #> ✔ First episode created in /tmp/RtmpD6AhNE/file16ef792514e8/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef792514e8... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef792514e8... #> ✔ Lesson successfully created in /tmp/RtmpD6AhNE/file16ef792514e8 #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef792514e8... #> /tmp/RtmpD6AhNE/file16ef792514e8 get_episodes(tmp) # produces warning #> [1] \"introduction.md\" set_episodes(tmp, get_episodes(tmp), write = TRUE) get_episodes(tmp) # no warning #> [1] \"introduction.md\" reset_episodes(tmp) get_episodes(tmp) # produces warning again because there is no schedule #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> [1] \"introduction.md\""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove all files associated with the site — reset_site","title":"Remove all files associated with the site — reset_site","text":"Use want rebuild site scratch.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove all files associated with the site — reset_site","text":"","code":"reset_site(path = \".\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_site.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove all files associated with the site — reset_site","text":"path path site","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_site.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Remove all files associated with the site — reset_site","text":"","code":"tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6eb1e32f... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6eb1e32f... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6eb1e32f... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6eb1e32f... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6eb1e32f... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef6eb1e32f/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6eb1e32f... #> ✔ First episode created in /tmp/RtmpD6AhNE/file16ef6eb1e32f/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6eb1e32f... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6eb1e32f... #> ✔ Lesson successfully created in /tmp/RtmpD6AhNE/file16ef6eb1e32f #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef6eb1e32f... #> /tmp/RtmpD6AhNE/file16ef6eb1e32f build_lesson(tmp, preview = FALSE) #> ── Initialising site ─────────────────────────────────────────────────── #> Copying <pkgdown>/BS3/assets/bootstrap-toc.css to bootstrap-toc.css #> Copying <pkgdown>/BS3/assets/bootstrap-toc.js to bootstrap-toc.js #> Copying <pkgdown>/BS3/assets/docsearch.css to docsearch.css #> Copying <pkgdown>/BS3/assets/docsearch.js to docsearch.js #> Copying <pkgdown>/BS3/assets/link.svg to link.svg #> Copying <pkgdown>/BS3/assets/pkgdown.css to pkgdown.css #> Copying <pkgdown>/BS3/assets/pkgdown.js to pkgdown.js #> Copying <varnish>/pkgdown/assets/android-chrome-192x192.png to #> android-chrome-192x192.png #> Copying <varnish>/pkgdown/assets/android-chrome-512x512.png to #> android-chrome-512x512.png #> Copying <varnish>/pkgdown/assets/apple-touch-icon.png to #> apple-touch-icon.png #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.ttf to #> assets/fonts/Mulish-Bold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.woff to #> assets/fonts/Mulish-Bold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.ttf to #> assets/fonts/Mulish-ExtraBold.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.eot to #> assets/fonts/mulish-v5-latin-regular.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.svg to #> assets/fonts/mulish-v5-latin-regular.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.ttf to #> assets/fonts/mulish-v5-latin-regular.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff to #> assets/fonts/mulish-v5-latin-regular.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff2 to #> assets/fonts/mulish-v5-latin-regular.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff to #> assets/fonts/mulish-variablefont_wght.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff2 to #> assets/fonts/mulish-variablefont_wght.woff2 #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo-sm.svg #> to assets/images/carpentries-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo.svg to #> assets/images/carpentries-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo-sm.svg to #> assets/images/data-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo.svg to #> assets/images/data-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/dropdown-arrow.svg to #> assets/images/dropdown-arrow.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo-sm.svg to #> assets/images/incubator-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo.svg to #> assets/images/incubator-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo-sm.svg to #> assets/images/lab-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo.svg to #> assets/images/lab-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo-sm.svg to #> assets/images/library-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo.svg to #> assets/images/library-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/minus.svg to #> assets/images/minus.svg #> Copying <varnish>/pkgdown/assets/assets/images/plus.svg to #> assets/images/plus.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo-sm.svg to #> assets/images/software-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo.svg to #> assets/images/software-logo.svg #> Copying <varnish>/pkgdown/assets/assets/scripts.js to assets/scripts.js #> Copying <varnish>/pkgdown/assets/assets/styles.css to assets/styles.css #> Copying <varnish>/pkgdown/assets/assets/styles.css.map to #> assets/styles.css.map #> Copying <varnish>/pkgdown/assets/assets/themetoggle.js to #> assets/themetoggle.js #> Copying <varnish>/pkgdown/assets/favicon-16x16.png to favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicon-32x32.png to favicon-32x32.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-114x114.png to #> favicons/cp/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-120x120.png to #> favicons/cp/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-144x144.png to #> favicons/cp/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-152x152.png to #> favicons/cp/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-57x57.png #> to favicons/cp/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-60x60.png #> to favicons/cp/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-72x72.png #> to favicons/cp/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-76x76.png #> to favicons/cp/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-128.png to #> favicons/cp/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-16x16.png to #> favicons/cp/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-196x196.png to #> favicons/cp/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-32x32.png to #> favicons/cp/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-96x96.png to #> favicons/cp/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon.ico to #> favicons/cp/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-144x144.png to #> favicons/cp/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-150x150.png to #> favicons/cp/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x150.png to #> favicons/cp/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x310.png to #> favicons/cp/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-70x70.png to #> favicons/cp/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-114x114.png to #> favicons/dc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-120x120.png to #> favicons/dc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-144x144.png to #> favicons/dc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-152x152.png to #> favicons/dc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-57x57.png #> to favicons/dc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-60x60.png #> to favicons/dc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-72x72.png #> to favicons/dc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-76x76.png #> to favicons/dc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-128.png to #> favicons/dc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-16x16.png to #> favicons/dc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-196x196.png to #> favicons/dc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-32x32.png to #> favicons/dc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-96x96.png to #> favicons/dc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon.ico to #> favicons/dc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-144x144.png to #> favicons/dc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-150x150.png to #> favicons/dc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x150.png to #> favicons/dc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x310.png to #> favicons/dc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-70x70.png to #> favicons/dc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-114x114.png to #> favicons/lc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-120x120.png to #> favicons/lc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-144x144.png to #> favicons/lc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-152x152.png to #> favicons/lc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-57x57.png #> to favicons/lc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-60x60.png #> to favicons/lc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-72x72.png #> to favicons/lc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-76x76.png #> to favicons/lc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-128.png to #> favicons/lc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-16x16.png to #> favicons/lc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-196x196.png to #> favicons/lc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-32x32.png to #> favicons/lc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-96x96.png to #> favicons/lc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon.ico to #> favicons/lc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-144x144.png to #> favicons/lc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-150x150.png to #> favicons/lc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x150.png to #> favicons/lc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x310.png to #> favicons/lc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-70x70.png to #> favicons/lc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-114x114.png to #> favicons/swc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-120x120.png to #> favicons/swc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-144x144.png to #> favicons/swc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-152x152.png to #> favicons/swc/apple-touch-icon-152x152.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-57x57.png to #> favicons/swc/apple-touch-icon-57x57.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-60x60.png to #> favicons/swc/apple-touch-icon-60x60.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-72x72.png to #> favicons/swc/apple-touch-icon-72x72.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-76x76.png to #> favicons/swc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-128.png to #> favicons/swc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-16x16.png to #> favicons/swc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-196x196.png to #> favicons/swc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-32x32.png to #> favicons/swc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-96x96.png to #> favicons/swc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon.ico to #> favicons/swc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-144x144.png to #> favicons/swc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-150x150.png to #> favicons/swc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x150.png to #> favicons/swc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x310.png to #> favicons/swc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-70x70.png to #> favicons/swc/mstile-70x70.png #> Copying <varnish>/pkgdown/assets/mstile-150x150.png to #> mstile-150x150.png #> Copying <varnish>/pkgdown/assets/safari-pinned-tab.svg to #> safari-pinned-tab.svg #> Copying <varnish>/pkgdown/assets/site.webmanifest to site.webmanifest dir(file.path(tmp, \"site\")) #> [1] \"DESCRIPTION\" \"README.md\" \"_pkgdown.yaml\" \"built\" #> [5] \"docs\" reset_site(tmp) dir(file.path(tmp, \"site\")) #> [1] \"DESCRIPTION\" \"README.md\" \"_pkgdown.yaml\" \"built\""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper-package.html","id":null,"dir":"Reference","previous_headings":"","what":"sandpaper: Create and Curate Carpentries Lessons — sandpaper-package","title":"sandpaper: Create and Curate Carpentries Lessons — sandpaper-package","text":"provide tools build Carpentries-themed lesson repository accessible standalone static website. include local tools designed used continuous integration context lesson author needs focus writing content actual lesson.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"sandpaper: Create and Curate Carpentries Lessons — sandpaper-package","text":"Maintainer: Robert Davey robertdavey@carpentries.org (ORCID) Authors: Erin Becker erinbecker@carpentries.org (ORCID) Zhian N. Kamvar zkamvar@carpentries.org (ORCID) Joel H. Nitta joelnitta@gmail.com (ORCID) [translator] contributors: Julien Colomb (ORCID) [contributor] Ben Companjen (ORCID) [contributor] Toby Hodges tobyhodges@carpentries.org [contributor] François Michonneau francois@carpentries.org [contributor] Kelly Barnes kbarnes@carpentries.org [contributor] Hugo Gruson hugo.gruson+R@normalesup.org [contributor] Milan Malfait milan.malfait94@gmail.com (ORCID) [contributor] Yanina Bellini Saibene (ORCID) [contributor, translator]","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper.options.html","id":null,"dir":"Reference","previous_headings":"","what":"Global Options — sandpaper.options","title":"Global Options — sandpaper.options","text":"documentation options","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper.options.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Global Options — sandpaper.options","text":"2022-02-22, several options used sandpaper may manipulated user. set may change future, description options set startup:","code":"option(\"sandpaper.show_draft\" = TRUE) option(\"sandpaper.links\" = NULL) option(\"sandpaper.use_renv\" = FALSE) option(\"sandpaper.package_cache_trigger\" = FALSE) option(\"sandpaper.test_fixture\" = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper.options.html","id":"sandpaper-show-draft","dir":"Reference","previous_headings":"","what":"sandpaper.show_draft","title":"Global Options — sandpaper.options","text":"Default: TRUE user messages. TRUE, message episodes draft status (.e. episodes folder, schedule) printed get_drafts(). Setting option FALSE turn feature.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper.options.html","id":"sandpaper-links","dir":"Reference","previous_headings":"","what":"sandpaper.links","title":"Global Options — sandpaper.options","text":"Default: NULL option provides way override default place links sandpaper lesson. NULL file called links.md top repository, appended bottom page rendered HTML.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper.options.html","id":"sandpaper-use-renv","dir":"Reference","previous_headings":"","what":"sandpaper.use_renv","title":"Global Options — sandpaper.options","text":"Default: variable option modified user. determines {renv} used locally R-based lessons. set use_package_cache() unset no_package_cache(). local user never consented using {renv} previously, defaults FALSE, {renv} previously used, TRUE.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper.options.html","id":"sandpaper-package-cache-trigger","dir":"Reference","previous_headings":"","what":"sandpaper.package_cache_trigger","title":"Global Options — sandpaper.options","text":"Default: FALSE locally/TRUE GitHub tells R Markdown lessons rebuild everything {renv} lockfile changes.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper.options.html","id":"sandpaper-test-fixture","dir":"Reference","previous_headings":"","what":"sandpaper.test_fixture","title":"Global Options — sandpaper.options","text":"Default: NULL internal use testing interactive components non-interactively setting {renv} behave correctly testing.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Site generator for sandpaper — sandpaper_site","title":"Site generator for sandpaper — sandpaper_site","text":"custom site generator compatibility rmarkdown::site_generator(). RStudio users, placing index.md yaml header make knit button work:","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Site generator for sandpaper — sandpaper_site","text":"","code":"sandpaper_site(input = \".\", ...)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper_site.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Site generator for sandpaper — sandpaper_site","text":"automatically added index.md sandpaper sites version 0.0.0.9013, maintainers need worry . Thanks goes Yihui Xie coming concept modular site generators JJ Alaire allowing sub-directory structures RMarkdown sites.","code":"site: sandpaper::sandpaper_site"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/serve.html","id":null,"dir":"Reference","previous_headings":"","what":"Build your lesson and work on it at the same time — serve","title":"Build your lesson and work on it at the same time — serve","text":"function serve lesson auto-update whenever save file.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/serve.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build your lesson and work on it at the same time — serve","text":"","code":"serve(path = \".\", quiet = !interactive(), ...)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/serve.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build your lesson and work on it at the same time — serve","text":"path path lesson. Defaults current path. quiet TRUE, messages printed output. Defaults FALSE non-interactive sessions, allows messages printed. ... options passed servr::server_config() way servr::httw(). can include port host configuration.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/serve.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build your lesson and work on it at the same time — serve","text":"output servr::httw(), invisibly. mainly used side-effect","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/serve.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build your lesson and work on it at the same time — serve","text":"sandpaper::serve() entry point working lesson using Carpentries Workbench. run function interactively, preview window open either RStudio browser address like localhost:4321 (note number likely different). make changes files lesson, preview update automatically. done preview, can run servr::daemon_stop().","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/serve.html","id":"command-line-usage","dir":"Reference","previous_headings":"","what":"Command line usage","title":"Build your lesson and work on it at the same time — serve","text":"can use command line use RStudio another IDE acts web browser. run command line, use: Note unlike interactive session, progress messages printed (except accessibility checks) browser window automatically launch. can messages print screen quiet = FALSE argument. addition, want specify port host function, can using port host arguments:","code":"R -e 'sandpaper::serve()' R -e 'sandpaper::serve(quiet = FALSE, host = \"127.0.0.1\", port = \"3435\")'"},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/serve.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build your lesson and work on it at the same time — serve","text":"","code":"if (FALSE) { # create an example lesson tmp <- tempfile() create_lesson(tmp, open = FALSE) # open the episode for editing file.edit(fs::path(tmp, \"episodes\", \"01-introduction.Rmd\")) # serve the lesson and begin editing the file. Watch how the file will # auto-update whenever you save it. sandpaper::serve() # # to stop the server, run servr::daemon_stop() # # If you want to use a different port, you can specify it directly sandpaper::serve(host = \"127.0.0.1\", port = \"3435\") }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":null,"dir":"Reference","previous_headings":"","what":"Set individual keys in a configuration file — set_config","title":"Set individual keys in a configuration file — set_config","text":"Set individual keys configuration file","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set individual keys in a configuration file — set_config","text":"","code":"set_config(pairs = NULL, create = FALSE, path = \".\", write = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set individual keys in a configuration file — set_config","text":"pairs named list character vector keys names new values contents create TRUE, new values pairs created appended; defaults FALSE, prevents typos sneaking . single key-pair values currently supported. path path lesson. Defaults current directory. write TRUE, schedule overwrite schedule current file.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Set individual keys in a configuration file — set_config","text":"function deals strictly keypairs yaml. lists, see set_dropdown().","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":"default-keypairs-known-by-sandpaper","dir":"Reference","previous_headings":"","what":"Default Keypairs Known by Sandpaper","title":"Set individual keys in a configuration file — set_config","text":"create new lesson sandpaper, set default keypairs pre-filled. make sure contact information links footer accurate, please modify values. carpentry [character] one cp, dc, swc, lab, incubator title [character] lesson title (e.g. 'Introduction R Plant Pathologists' created [character] Date ISO 8601 format (e.g. '2021-02-09') keywords [character] comma-separated list (e.g 'static site, R, tidyverse') life_cycle [character] one pre-alpha, alpha, beta, stable license [character] license lesson (e.g. 'CC-4.0') source [character] source repository URL branch [character] default branch (e.g. 'main') contact [character] email address contact information lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":"optional-keypairs-known-by-sandpaper","dir":"Reference","previous_headings":"","what":"Optional Keypairs Known by Sandpaper","title":"Set individual keys in a configuration file — set_config","text":"following keypairs known sandpaper, optional: lang [character] language code matches language lesson content. defaults \"en\", can language code (e.g. \"ja\" specifying Japanese) combination language code country code (e.g. \"pt_BR\" specifies Pourtugese used Brazil). information used, see Locale Names section gettext manual url [character] custom URL deploying URL default github pages io domain. fail_on_error [boolean] R Markdown lessons; fail build chunks produce error. Use #| error: true chunk options allow error displayed workbench-beta [boolean] truthy, displays banner site indicates site workbench beta phase. overview [boolean] lessons must episodes exception overview lessons. indicate lesson serves overview lessons, use overview: true handout [boolean] [character] option instructs {sandpaper} create handout RMarkdown files via {pegboard}, uses knitr::purl() background removing everything challenges (without solutions) code blocks purl = TRUE. default path handout files/code-handout.R workbench becomes developed, optional keys may disappear.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":"custom-engines","dir":"Reference","previous_headings":"","what":"Custom Engines","title":"Set individual keys in a configuration file — set_config","text":"use specific version sandpaper varnish locally, install using remotes::install_github(\"carpentries/sandpaper@VERSION\") syntax, provision versions GitHub, can provision config.yaml file: sandpaper [character] github string version number sandpaper version use varnish [character] github string version number varnish version use pegboard [character] github string version number pegboard version use example, forked version varnish modify colourscheme, use: specific branch sandpaper varnish tested, want test lesson temporarily, use @ symbol refer specific branch commit use:","code":"varnish: MYACCOUNT/varnish sandpaper: carpentries/sandpaper@BRANCH-NAME varnish: carpentries/varnish@BRANCH-name"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set individual keys in a configuration file — set_config","text":"","code":"if (FALSE) { tmp <- tempfile() create_lesson(tmp, \"test lesson\", open = FALSE, rmd = FALSE) # Change the title and License (default vars) set_config(c(title = \"Absolutely Free Lesson\", license = \"CC0\"), path = tmp, write = TRUE ) # add the URL and workbench-beta indicator set_config(list(\"workbench-beta\" = TRUE, url = \"https://example.com/\"), path = tmp, create = TRUE, write = TRUE ) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_dropdown.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the order of items in a dropdown menu — set_dropdown","title":"Set the order of items in a dropdown menu — set_dropdown","text":"Set order items dropdown menu","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_dropdown.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the order of items in a dropdown menu — set_dropdown","text":"","code":"set_dropdown(path = \".\", order = NULL, write = FALSE, folder) set_episodes(path = \".\", order = NULL, write = FALSE) set_learners(path = \".\", order = NULL, write = FALSE) set_instructors(path = \".\", order = NULL, write = FALSE) set_profiles(path = \".\", order = NULL, write = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_dropdown.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the order of items in a dropdown menu — set_dropdown","text":"path path lesson. Defaults current directory. order files order presented (extension) write TRUE, schedule overwrite schedule current file. folder one four folders sandpaper recognises files listed order located: episodes, learners, instructors, profiles.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_dropdown.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set the order of items in a dropdown menu — set_dropdown","text":"","code":"tmp <- tempfile() create_lesson(tmp, \"test lesson\", open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef502078ae... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef502078ae... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef502078ae... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef502078ae... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef502078ae... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef502078ae/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef502078ae... #> ✔ First episode created in /tmp/RtmpD6AhNE/file16ef502078ae/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef502078ae... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef502078ae... #> ✔ Lesson successfully created in /tmp/RtmpD6AhNE/file16ef502078ae #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef502078ae... #> /tmp/RtmpD6AhNE/file16ef502078ae # Change the title and License set_config(c(title = \"Absolutely Free Lesson\", license = \"CC0\"), path = tmp, write = TRUE ) #> ℹ Writing to /tmp/RtmpD6AhNE/file16ef502078ae/config.yaml #> → title: 'test lesson' -> title: 'Absolutely Free Lesson' #> → license: 'CC-BY 4.0' -> license: 'CC0' create_episode(\"using-R\", path = tmp, open = FALSE) #> ☐ Edit /tmp/RtmpD6AhNE/file16ef502078ae/episodes/using-r.Rmd. #> /tmp/RtmpD6AhNE/file16ef502078ae/episodes/using-r.Rmd print(sched <- get_episodes(tmp)) #> [1] \"introduction.md\" \"using-r.Rmd\" # reverse the schedule set_episodes(tmp, order = rev(sched)) #> episodes: #> - using-r.Rmd #> - introduction.md #> #> ──────────────────────────────────────────────────────────────────────── #> ℹ To save this configuration, use #> #> set_episodes(path = tmp, order = rev(sched), write = TRUE) # write it set_episodes(tmp, order = rev(sched), write = TRUE) # see it get_episodes(tmp) #> [1] \"using-r.Rmd\" \"introduction.md\""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_globals.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the necessary common global variables for use in the {varnish} template. — set_globals","title":"Set the necessary common global variables for use in the {varnish} template. — set_globals","text":"enforce four global lists:","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_globals.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the necessary common global variables for use in the {varnish} template. — set_globals","text":"","code":"set_globals(path)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_globals.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the necessary common global variables for use in the {varnish} template. — set_globals","text":"path path lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_globals.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Set the necessary common global variables for use in the {varnish} template. — set_globals","text":".resources, equivalent output get_resource_list() this_metadata, contains metadata common lesson learner_globals navigation items learners instructor_globals namvigation items instructors things added: sidebar generated create_sidebar() learner instructor globals exception first element. \"\" dropdown menu, created via create_resources_dropdown(). resources \"\", positioned mobile sidebar. {sandpaper,varnish,pegboard}_version package versions package.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/strip_prefix.html","id":null,"dir":"Reference","previous_headings":"","what":"This will strip existing episode prefixes and set the schedule — strip_prefix","title":"This will strip existing episode prefixes and set the schedule — strip_prefix","text":"Episode order Carpentries lessons originally used strategy prefixing files two-digit number force specific order filename. function strip numbers filename set schedule according original order.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/strip_prefix.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"This will strip existing episode prefixes and set the schedule — strip_prefix","text":"","code":"strip_prefix(path = \".\", write = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/strip_prefix.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"This will strip existing episode prefixes and set the schedule — strip_prefix","text":"path path lesson (defaults current working directory) write defaults FALSE, show potential changes. TRUE, schedule modified written config.yaml","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/strip_prefix.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"This will strip existing episode prefixes and set the schedule — strip_prefix","text":"write = TRUE, modified list episodes. write = FALSE, modified call returned.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/strip_prefix.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"This will strip existing episode prefixes and set the schedule — strip_prefix","text":"git recognise deleting file adding new file stage. run git add, recognise rename.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/strip_prefix.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"This will strip existing episode prefixes and set the schedule — strip_prefix","text":"","code":"if (FALSE) { strip_prefix() # test if the function is doing what you want it to do strip_prefix(write = TRUE) # rewrite the episode names }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/template.html","id":null,"dir":"Reference","previous_headings":"","what":"Template files — template_gitignore","title":"Template files — template_gitignore","text":"Use files templates sandpaper lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/template.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Template files — template_gitignore","text":"","code":"template_gitignore() template_episode() template_links() template_citation() template_config() template_conduct() template_index() template_license() template_contributing() template_setup() template_pkgdown() template_placeholder() template_pr_diff() template_sidebar_item() template_metadata()"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/template.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Template files — template_gitignore","text":"character string path template within {sandpaper} repo.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/template.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Template files — template_gitignore","text":"","code":"cat(readLines(template_gitignore(), n = 6), sep = \"\\n\") #> # sandpaper files #> episodes/*html #> site/* #> !site/README.md #> #> # History files"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":null,"dir":"Reference","previous_headings":"","what":"Establish and Manage Translation Strings — these","title":"Establish and Manage Translation Strings — these","text":"documentation internal functions translation. want guide providing translations, please read vignette(\"translations\", package = \"sandpaper\")","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Establish and Manage Translation Strings — these","text":"","code":"these establish_translation_vars() set_language(lang = NULL) tr_src(from = \"varnish\", key = NULL) tr_get(from = \"varnish\", key = NULL) tr_varnish(key = NULL) tr_computed(key = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Establish and Manage Translation Strings — these","text":"object class environment length 1.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Establish and Manage Translation Strings — these","text":"lang two-letter language code (optionally country code). Defaults NULL, falls back English (language source code). single character specifying translation list fetch. defaults \"varnish\" can one following: src varnish computed key single character specifying specific key fetch translation list. defaults NULL, returning whole list.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Establish and Manage Translation Strings — these","text":"key = NULL, list key single character, result unnamed character vector length 1 representing value list.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Establish and Manage Translation Strings — these","text":"page generated {sandpaper} made user-provided content wrapped templated HTML provided {varnish}. Since users can provide content human language can processed computer, {sandpaper} must method match template content language content. translations added source {sandpaper} volunteers using {potools} package. Template content strings stored $translations element global environment variable, generated establish_translation_vars() function, run every time {sandpaper} loaded. $translations element consists three lists: varnish: list translated strings passed directly {varnish} computed: list translated strings incorporated HTML content passed {varnish}. src: source list two lists serves source translations. Whenever lesson built, function set_language() read lang item config.yaml apply translations $translations$varnish $translations$computed lesson generated updated.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":"list-of-translation-variables","dir":"Reference","previous_headings":"","what":"List of Translation Variables","title":"Establish and Manage Translation Strings — these","text":"62 translations generated set_language() correspond following variables {varnish}: addition, 26 translations inserted get {varnish}:","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Establish and Manage Translation Strings — these","text":"","code":"# When sandpaper is loaded, these functions return English snd <- asNamespace(\"sandpaper\") head(snd$tr_varnish()) #> $SkipToMain #> [1] \"Skip to main content\" #> #> $iPreAlpha #> [1] \"Pre-Alpha\" #> #> $PreAlphaNote #> [1] \"This lesson is in the pre-alpha phase, which means that it is in early development, but has not yet been taught.\" #> #> $AlphaNote #> [1] \"This lesson is in the alpha phase, which means that it has been taught once and lesson authors are iterating on feedback.\" #> #> $iAlpha #> [1] \"Alpha\" #> #> $BetaNote #> [1] \"This lesson is in the beta phase, which means that it is ready for teaching by instructors outside of the original author team.\" #> head(snd$tr_computed()) #> $OUTPUT #> [1] \"OUTPUT\" #> #> $WARNING #> [1] \"WARNING\" #> #> $ERROR #> [1] \"ERROR\" #> #> $Overview #> [1] \"Overview\" #> #> $Questions #> [1] \"Questions\" #> #> $Objectives #> [1] \"Objectives\" #> # Setting language to Spanish will translate the computed and varnish snd$set_language(\"es\") head(snd$tr_varnish()) #> $SkipToMain #> [1] \"Ir al contenido principal\" #> #> $iPreAlpha #> [1] \"Pre-Alfa\" #> #> $PreAlphaNote #> [1] \"Esta lección se encuentra en la fase pre-alfa, lo que significa que está en las primeras etapas de desarrollo, pero aún no se ha enseñado.\" #> #> $AlphaNote #> [1] \"Esta lección se encuentra en la fase alfa, lo que significa que se ha enseñado una vesy las autoras de la lección están trabajando en los comentarios.\" #> #> $iAlpha #> [1] \"Alfa\" #> #> $BetaNote #> [1] \"Esta lección se encuentra en la fase beta, lo que significa que está lista para enseñarpor instructoras que no son parte del equipo original de autoras\" #> head(snd$tr_computed()) #> $OUTPUT #> [1] \"SALIDA\" #> #> $WARNING #> [1] \"ADVERTENCIA\" #> #> $ERROR #> [1] \"ERROR\" #> #> $Overview #> [1] \"Hoja de ruta\" #> #> $Questions #> [1] \"Preguntas\" #> #> $Objectives #> [1] \"Objetivos\" #> # The source will remain the same head(snd$tr_src(\"varnish\")) #> $SkipToMain #> [1] \"Skip to main content\" #> #> $iPreAlpha #> [1] \"Pre-Alpha\" #> #> $PreAlphaNote #> [1] \"This lesson is in the pre-alpha phase, which means that it is in early development, but has not yet been taught.\" #> #> $AlphaNote #> [1] \"This lesson is in the alpha phase, which means that it has been taught once and lesson authors are iterating on feedback.\" #> #> $iAlpha #> [1] \"Alpha\" #> #> $BetaNote #> [1] \"This lesson is in the beta phase, which means that it is ready for teaching by instructors outside of the original author team.\" #> head(snd$tr_src(\"computed\")) #> $OUTPUT #> [1] \"OUTPUT\" #> #> $WARNING #> [1] \"WARNING\" #> #> $ERROR #> [1] \"ERROR\" #> #> $Overview #> [1] \"Overview\" #> #> $Questions #> [1] \"Questions\" #> #> $Objectives #> [1] \"Objectives\" #> # Running set_language with no arguments defaults to English snd$set_language() head(snd$tr_varnish()) #> $SkipToMain #> [1] \"Skip to main content\" #> #> $iPreAlpha #> [1] \"Pre-Alpha\" #> #> $PreAlphaNote #> [1] \"This lesson is in the pre-alpha phase, which means that it is in early development, but has not yet been taught.\" #> #> $AlphaNote #> [1] \"This lesson is in the alpha phase, which means that it has been taught once and lesson authors are iterating on feedback.\" #> #> $iAlpha #> [1] \"Alpha\" #> #> $BetaNote #> [1] \"This lesson is in the beta phase, which means that it is ready for teaching by instructors outside of the original author team.\" #> head(snd$tr_computed()) #> $OUTPUT #> [1] \"OUTPUT\" #> #> $WARNING #> [1] \"WARNING\" #> #> $ERROR #> [1] \"ERROR\" #> #> $Overview #> [1] \"Overview\" #> #> $Questions #> [1] \"Questions\" #> #> $Objectives #> [1] \"Objectives\" #>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/try_use_renv.html","id":null,"dir":"Reference","previous_headings":"","what":"Try to use {renv} — try_use_renv","title":"Try to use {renv} — try_use_renv","text":"use sandpaper starts see user previously consented {renv}. problem renv::consent() throws TRUE user consented error :(","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/try_use_renv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Try to use {renv} — try_use_renv","text":"","code":"try_use_renv(force = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/try_use_renv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Try to use {renv} — try_use_renv","text":"force TRUE, consent forced TRUE, creating cache directory exist . Defaults FALSE, gently inquires consent.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/try_use_renv.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Try to use {renv} — try_use_renv","text":"character vector","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/try_use_renv.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Try to use {renv} — try_use_renv","text":"function wraps renv::consent() callr function transforms error FALSE. sets sandpaper.use_renv variable value check returns full text output FALSE (WELCOME message given someone uses {renv} first time) last line output TRUE (message either directory created consent already provided.)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_github_workflows.html","id":null,"dir":"Reference","previous_headings":"","what":"Update github workflows — update_github_workflows","title":"Update github workflows — update_github_workflows","text":"function copies updates workflows run {sandpaper}.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_github_workflows.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update github workflows — update_github_workflows","text":"","code":"update_github_workflows( path = \".\", files = \"\", overwrite = TRUE, clean = \"*.yaml\", quiet = FALSE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_github_workflows.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update github workflows — update_github_workflows","text":"path path current lesson. files files include update. Defaults empty string, update files overwrite TRUE (default), file(s) overwritten. clean glob files cleaned writing. Defaults \"*.yaml\". remove files four-letter \"yaml\" extension (remove \".yml\" extension). can also specify whole file name like \"workflow.yaml\" remove one specific file. want clean, set NULL. quiet TRUE, process output messages, default FALSE, report progress step.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_github_workflows.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update github workflows — update_github_workflows","text":"paths new files.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_varnish.html","id":null,"dir":"Reference","previous_headings":"","what":"Update the local version of the carpentries style — update_varnish","title":"Update the local version of the carpentries style — update_varnish","text":"Update local version carpentries style","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_varnish.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update the local version of the carpentries style — update_varnish","text":"","code":"update_varnish(version = NULL, ...)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_varnish.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update the local version of the carpentries style — update_varnish","text":"version NULL, update latest version, otherwise, can version string identify specific version use. ... arguments passed utils::install.packages()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_varnish.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update the local version of the carpentries style — update_varnish","text":"NULL, invisibly","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_varnish.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Update the local version of the carpentries style — update_varnish","text":"requires internet connection","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":null,"dir":"Reference","previous_headings":"","what":"Pre-build validation of lesson elements — validate_lesson","title":"Pre-build validation of lesson elements — validate_lesson","text":"validator based pegboard::Lesson class cached this_lesson() provide line reports fenced divs, links, images, heading structure. details type validators avaliable, see {pegboard} article Validation Lesson Elements","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pre-build validation of lesson elements — validate_lesson","text":"","code":"validate_lesson(path = \".\", headings = FALSE, quiet = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pre-build validation of lesson elements — validate_lesson","text":"path path lesson. Defaults ot current directory headings TRUE, headings checked validated. Currently set FALSE re-investigating false positives. quiet TRUE, messages issued, otherwise progress messages issued test","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pre-build validation of lesson elements — validate_lesson","text":"list results test described pegboard::Lesson","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":"headings","dir":"Reference","previous_headings":"","what":"Headings","title":"Pre-build validation of lesson elements — validate_lesson","text":"expect headings semantic informative. Details tests headings can found pegboard::validate_headings()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":"internal-links-and-images","dir":"Reference","previous_headings":"","what":"Internal Links and Images","title":"Pre-build validation of lesson elements — validate_lesson","text":"Internal links images exist images alt text. Details tests can found pegboard::validate_links()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":"fenced-divs-callout-blocks-","dir":"Reference","previous_headings":"","what":"Fenced Divs (callout blocks)","title":"Pre-build validation of lesson elements — validate_lesson","text":"Callout Blocks one expected types. Details test can found pegboard::validate_divs()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Pre-build validation of lesson elements — validate_lesson","text":"","code":"tmp <- tempfile() lsn <- create_lesson(tmp, open = FALSE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4e7f4061... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4e7f4061... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4e7f4061... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4e7f4061... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4e7f4061... #> ☐ Edit /tmp/RtmpD6AhNE/file16ef4e7f4061/episodes/introduction.Rmd. #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4e7f4061... #> ✔ First episode created in /tmp/RtmpD6AhNE/file16ef4e7f4061/episodes/introduction.Rmd #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4e7f4061... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4e7f4061... #> ℹ Consent to use package cache provided #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4e7f4061... #> - The project is out-of-sync -- use `renv::status()` for details. #> → Searching for and installing available dependencies #> The following packages were discovered: #> #> # ~/work/_temp/Library ------------------------------------------------------- #> - R6 2.5.1 #> - base64enc 0.1-3 #> - bslib 0.8.0 #> - cachem 1.1.0 #> - cli 3.6.3 #> - digest 0.6.37 #> - evaluate 1.0.1 #> - fastmap 1.2.0 #> - fontawesome 0.5.2 #> - fs 1.6.4 #> - glue 1.8.0 #> - highr 0.11 #> - htmltools 0.5.8.1 #> - jquerylib 0.1.4 #> - jsonlite 1.8.9 #> - knitr 1.48 #> - lifecycle 1.0.4 #> - memoise 2.0.1 #> - mime 0.12 #> - rappdirs 0.3.3 #> - rlang 1.1.4 #> - rmarkdown 2.28 #> - sass 0.4.9 #> - tinytex 0.53 #> - xfun 0.48 #> - yaml 2.3.10 #> #> They will be copied into the project library. #> #> - Copying packages into the project library ... Done! #> - Hydrated 26 packages in 0.21 seconds. #> - The project is out-of-sync -- use `renv::status()` for details. #> → Recording changes in lockfile #> The following package(s) will be updated in the lockfile: #> #> # https://packagemanager.posit.co/cran/__linux__/jammy/latest ---------------- #> - R6 [* -> 2.5.1] #> - base64enc [* -> 0.1-3] #> - bslib [* -> 0.8.0] #> - cachem [* -> 1.1.0] #> - cli [* -> 3.6.3] #> - digest [* -> 0.6.37] #> - evaluate [* -> 1.0.1] #> - fastmap [* -> 1.2.0] #> - fontawesome [* -> 0.5.2] #> - fs [* -> 1.6.4] #> - glue [* -> 1.8.0] #> - highr [* -> 0.11] #> - htmltools [* -> 0.5.8.1] #> - jquerylib [* -> 0.1.4] #> - jsonlite [* -> 1.8.9] #> - knitr [* -> 1.48] #> - lifecycle [* -> 1.0.4] #> - memoise [* -> 2.0.1] #> - mime [* -> 0.12] #> - rappdirs [* -> 0.3.3] #> - renv [* -> 1.0.11] #> - rlang [* -> 1.1.4] #> - rmarkdown [* -> 2.28] #> - sass [* -> 0.4.9] #> - tinytex [* -> 0.53] #> - xfun [* -> 0.48] #> - yaml [* -> 2.3.10] #> #> The version of R recorded in the lockfile will be updated: #> - R [* -> 4.4.1] #> #> - Lockfile written to \"/tmp/RtmpD6AhNE/file16ef4e7f4061/renv/profiles/lesson-requirements/renv.lock\". #> ✔ Lesson successfully created in /tmp/RtmpD6AhNE/file16ef4e7f4061 #> → Creating Lesson in /tmp/RtmpD6AhNE/file16ef4e7f4061... validate_lesson(lsn, headings = TRUE) #> ── Validating Headings ───────────────────────────────────────────────── #> ── Validating Fenced Divs ────────────────────────────────────────────── #> ── Validating Internal Links and Images ────────────────────────────────"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/work_with_cache.html","id":null,"dir":"Reference","previous_headings":"","what":"(Experimental) Work with the package cache — work_with_cache","title":"(Experimental) Work with the package cache — work_with_cache","text":"function designed can work lesson inside package cache without overwriting personal library.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/work_with_cache.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"(Experimental) Work with the package cache — work_with_cache","text":"","code":"work_with_cache(profile = \"lesson-requirements\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/work_with_cache.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"(Experimental) Work with the package cache — work_with_cache","text":"function reset R environment original state","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/work_with_cache.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"(Experimental) Work with the package cache — work_with_cache","text":"","code":"if (interactive() && fs::dir_exists(\"episodes\")) { library(\"sandpaper\") done <- work_with_cache() print(.libPaths()) # install.packages(\"cowsay\") # install cowsay to your lesson cache # cowsay::say() # hello world # detach('package:cowsay') # detach the package from your current session done() # finish the session # try(cowsay::say()) # this fails because it's not in your global library print(.libPaths()) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/yaml_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a valid, opinionated yaml list for insertion into a whisker template — yaml_list","title":"Create a valid, opinionated yaml list for insertion into a whisker template — yaml_list","text":"Create valid, opinionated yaml list insertion whisker template","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/yaml_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a valid, opinionated yaml list for insertion into a whisker template — yaml_list","text":"","code":"yaml_list(thing)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/yaml_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a valid, opinionated yaml list for insertion into a whisker template — yaml_list","text":"thing vector list","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/yaml_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a valid, opinionated yaml list for insertion into a whisker template — yaml_list","text":"character vector want manipulate config file command line preserve comments. Unfortunately, yaml C library parse comments makes things difficult handle. moment hack use whisker templates , drawback whisker know handle lists, concatenates commas: Moreover, want indicate yaml list single key/value pair want enforce converts elements yaml list enters whisker makes sure values clearly lists.","code":"x <- c(\"a\", \"b\", \"c\") hx <- list(hello = x) cat(yaml::as.yaml(hx)) # representation in yaml #> hello: #> - a #> - b #> - c cat(whisker::whisker.render(\"hello: {{hello}}\", hx)) # messed up whisker #> hello: a,b,c key: - value1 key: value1 hx[[\"hello\"]] <- sandpaper:::yaml_list(hx[[\"hello\"]]) cat(whisker::whisker.render(\"hello: {{hello}}\", hx)) # good whisker #> hello: #> - a #> - b #> - c"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/yaml_list.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Create a valid, opinionated yaml list for insertion into a whisker template — yaml_list","text":"better solution hack, now, keep okay purposes: https://github.com/rstudio/blogdown/issues/560","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/yaml_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a valid, opinionated yaml list for insertion into a whisker template — yaml_list","text":"","code":"x <- c(\"a\", \"b\", \"c\") hx <- list(hello = x) cat(yaml::as.yaml(hx)) # representation in yaml #> hello: #> - a #> - b #> - c cat(whisker::whisker.render(\"hello: {{hello}}\", hx)) # messed up whisker #> hello: a,b,c hx[[\"hello\"]] <- sandpaper:::yaml_list(hx[[\"hello\"]]) cat(whisker::whisker.render(\"hello: {{hello}}\", hx)) # good whisker #> hello: #> - a #> - b #> - c"},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-16-8","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.16.8 (2024-10-11)","text":"Pin workflow ubuntu-22.04 instead ubuntu-latest (reported @chrbknudsen #605, fixed @froggleston #606) Update notes remove excessive build warnings (@milanmlft #599)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"languages-0-16-8","dir":"Changelog","previous_headings":"","what":"LANGUAGES","title":"sandpaper 0.16.8 (2024-10-11)","text":"Add R-de.po German translations lesson elements (@martin-raden #607)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-16-8","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.16.8 (2024-10-11)","text":"Added @martin-raden contributor translator - welcome!","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-16-7","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.16.7 (2024-09-04)","text":"Add overwrite option pr workflow fix change default update-artifact action v3 v4 (@milanmlft #602)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-16-6","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.16.6 (2024-08-23)","text":"Regression fix update pkgdown resulting duplicated untranslated h2 anchors sections (@froggleston #600) Fix various action warnings issues relating old Node.js versions (@jhlegarreta #596) Update core actions v4 (@Bisaloo #577)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-16-6","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.16.6 (2024-08-23)","text":"Allow custom carpentry config types, associated alt-text descriptions support alternative logos/theming lessons (@milanmlft #585, @ErinBecker) Add support French translations core lesson components/sections (@Bisaloo #595)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-16-5","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.16.5 (2024-06-18)","text":"Fix empty divs checking headers (reported: @dmgatti, #581; fixed @froggleston) Fix spacing callout titles inner tags, e.g. <code> (reported: @abostroem, #562; fixed @froggleston)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-16-5","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.16.5 (2024-06-18)","text":"Add support including Carpentries matomo tracker, custom user-supplied tracker script, tracking (reported: @tbyhdgs, @fiveop https://github.com/carpentries/varnish/issues/37, @zkamvar https://github.com/carpentries/sandpaper/issues/438, implemented: @froggleston )","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-16-4","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.16.4 (2024-04-10)","text":"lesson page footer now supports either CITATION CITATION.cff file (reported: @tobyhodges, implemented: @froggleston, #572; @tobyhodges, https://github.com/carpentries/varnish/pull/122) Add support tabbed content lessons (reported: @astroDimitrios, implemented: @astroDimitrios, @froggleston, https://github.com/carpentries/sandpaper/pull/571, https://github.com/carpentries/varnish/pull/121, https://github.com/carpentries/pegboard/pull/148 ).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-16-3","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.16.3 (2024-03-12)","text":"Hotfix pandoc2--pandoc3 bump resulted CSS deduplication section classes callout blocks (reported: @bencomp, #470; @ndporter https://github.com/carpentries/workbench/issues/81; fixed: @froggleston, #574)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-16-2","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.16.2 (2023-12-19)","text":"JSON metadata now contains inLanguage key.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"documentation-0-16-2","dir":"Changelog","previous_headings":"","what":"DOCUMENTATION","title":"sandpaper 0.16.2 (2023-12-19)","text":"list translatable strings now added vignette(\"translations\", package = \"sandpaper\")","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"internal-0-16-2","dir":"Changelog","previous_headings":"","what":"INTERNAL","title":"sandpaper 0.16.2 (2023-12-19)","text":"Translation strings now unduplicated live single file (R/utils-translate.R). make finding updating strings easier maintainer translators. Translations now live global environment called $translations new documentation page called ?translate contains details translations template elements rendered. tr_src() helper function provides access source strings translations. tr_get(), tr_varnish(), tr_computed() helper functions provide access top lists translated strings. replaced tr_() strings point generation.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-16-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.16.1 (2023-12-14)","text":"Callout headings markup titles longer text duplicated (reported: @zkamvar, #556; fixed: @zkamvar, #557)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-16-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.16.0 (2023-12-13)","text":"now possible build lessons languages English website elements also localised language (reported: @zkamvar, #205, @joelnitta, #544; fixed: @joelnitta @zkamvar, #546). known_languages() function return language codes known {sandpaper}.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"documentation-0-16-0","dir":"Changelog","previous_headings":"","what":"DOCUMENTATION","title":"sandpaper 0.16.0 (2023-12-13)","text":"new vignette vignette(\"translation\", package = \"sandpaper\") describes translation template components works submit new/update translations (added: @zkamvar, #546). new vignette data flow vignette(\"data-flow\", package = \"sandpaper\") describes templating, translations, lesson metadata flows {sandpaper} {varnish} (added: @zkamvar, #553)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-16-0","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.16.0 (2023-12-13)","text":"spelling keypoints now consistent menu item callout blocks (reported: @clarallebot, https://github.com/carpentries/workbench/issues/44; fixed: @zkamvar, #546)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-16-0","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.16.0 (2023-12-13)","text":"{withr} package upgraded import suggested package.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"languages-0-16-0","dir":"Changelog","previous_headings":"","what":"LANGUAGES","title":"sandpaper 0.16.0 (2023-12-13)","text":"Japanese (ja) (added: @joelnitta, #546) Spanish (es) (added: @yabellini, #552)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-16-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.16.0 (2023-12-13)","text":"Added @yabellini contributor translator Added @joelnitta author translator","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-15-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.15.0 (2023-11-29)","text":"Using handout: true config.yaml cause handout generated lesson website /files/code-handout.R. moment, relevant R-based lessons (implemented: @froggleston, #527, reviewed: @zkamvar) supersedes need specifying options(sandpaper.handout = TRUE) Content learners now accessible instructor view. instructor view “” dropdown menu item now links learner view items appended. Note clicking links, user remain instructor view. behaviour may change future iterations (reported: @karenword, #394; fixed: @ErinBecker, #530, reviewed: @zkamvar) create_episode() now open new episodes editing interactive sessions (implemented: @milanmlft, #534, reviewed: @zkamvar) site/ folder now customisable writable directory system setting experimental SANDPAPER_SITE environment variable valid empty folder. useful context Docker containers, file permissions mounted volumes always guaranteed (reported: @fherreazcue #536; implemented: @zkamvar, #537) DOI badges can now displayed paired {varnish} version 0.4.0 adding doi: key config.yaml file either raw DOI URL DOI (reported: @tobyhodges, carpentries/workbench#67; fixed: @tobyhodges, #535).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-15-0","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.15.0 (2023-11-29)","text":"Internal build_status() function: make sure root_path() always points lesson root (reported: @milanmlft, #531; fixed: @milanmlft, #532)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-15-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.15.0 (2023-11-29)","text":"Added @milanmlft contributor","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-14-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.14.1 (2023-11-09)","text":"mailto: links longer prepended URL (reported: @apirogov, #538; fixed: @zkamvar, #539)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-14-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.14.0 (2023-10-02)","text":"internal folders can contain standard files, fig, data folders cautionary note duplicate file names folders cause error. validate_lesson() now reports invalid elements child documents new vignette vignette(\"include-child-documents\", package = \"sandpaper\") demonstrates describes caveats using child documents.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-14-0","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.14.0 (2023-10-02)","text":"overview child files longer built top-level files.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-14-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.14.0 (2023-10-02)","text":"R Markdown episodes nested child documents (grand children beyond) now trigger episode rebuild (fixed: @zkamvar, #513) Child file detection functionality moved {pegboard} package","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-14-0","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.14.0 (2023-10-02)","text":"{pegboard} minimum version now 0.7.0","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-13-3","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.13.3 (2023-09-22)","text":"References heading setup.md now reflected website. (reported: @tobyhodges, @fnattino, @zkamvar, #521; fixed: @ErinBecker @zkamvar, #522). regression #514 empty menus cause failure deployment 404 page fixed (reported: @tobyhodges @zkamvar, #519; fixed: @zkamvar, #520).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-13-2","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.13.2 (2023-09-20)","text":"Users duplicated init.defaultBranch declarations git config longer fail default branch check (reported: @tesaunders, #516; fixed: @zkamvar, #517)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-13-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.13.1 (2023-09-19)","text":"Aggregate pages longer fail episode prefix aggregate page (e.g. images.html longer fail episode starts images-) (reported: @mwhamgenomics, #511; fixed: @zkamvar, #512) 404 page index link point default index page site instead relative index page, result 404 nested links exist (reported: @kaijagahm @zkamvar, #498; fixed @zkamvar, #514)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-13-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.13.0 (2023-09-06)","text":"Overview style lessons episodic content can now processed, analysed, built {sandpaper}. make lesson overview lesson, can add overview: true config.yaml (reported: @zkamvar, https://github.com/carpentries/workbench/issues/65; implemented: @zkamvar, #496) new spoiler class fenced div allow authors specify expandable section content collapsed default. replaces former paradigm using “floating solution” blocks present options installation different platforms. (implemented: @tobyhodges, #502)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-13-0","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.13.0 (2023-09-06)","text":"Internal function root_path() longer fail episodes/ folder exist long one four folders (site/, learners/, instructors/, profiles/) exists (fixed: @zkamvar, #496) set_config() can now properly process logical values true false R Markdown documents modificiations child documents now take account changes child documents (reported @jcolomb, #497; fixed @zkamvar, #498). broken test development version {renv} fixed. change output functionality, user-visible changes (reported: @zkamvar, #484; fixed: @zkamvar, #487). Broken snapshot tests upstream R-devel fixed ensuring version comparisons always use characters numbers (ergonomically weird, whatever) (reported: @zkamvar #487; fixed: @zkamvar #487) Blank instructor notes pages longer fail build (reported: @apirogov, #505; fixed: @klbarnes20, #509) Tests {renv} post 1.0.0 fixed longer run forever interactively (reported: @zkamvar #500; fixed: @zkamvar, #501)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-13-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.13.0 (2023-09-06)","text":"now testing pandoc 2.19.2 continuous integration. discussion list link new lesson contributing template fixed. examples modified use R Markdown lessons unless necessary, reducing output time needed build examples.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-13-0","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.13.0 (2023-09-06)","text":"README file updated fix typo.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-13-0","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.13.0 (2023-09-06)","text":"{pegboard} minimum version now 0.6.0 {varnish} minimum version now 0.3.0","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-12-4","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.12.4 (2023-06-16)","text":"bug walled systems templated pages (e.g. 404) written due permissions issues fixed (reported: @ocaisa, #479; fixed: @zkamvar, #482).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-12-3","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.12.3 (2023-06-01)","text":"bug git credentials accidentally changed lesson built fixed longer querying git author lesson built. (reported: @joelnitta, @velait, @zkamvar, #449; fixed: @zkamvar, #476).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-12-2","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.12.2 (2023-05-29)","text":"bug sidebar non-episode pages extra commas fixed (reported: @zkamvar, #473; fixed: @zkamvar, #474)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-12-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.12.1 (2023-05-26)","text":"current page sidebar longer hides episode number. (reported: @cynthiaftw, https://github.com/carpentries/workbench/issues/42 #432; fixed: @zkamvar, #472) metadata episodes titles containing markup longer include markup metadata (@zkamvar, #472)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-12-1","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.12.1 (2023-05-26)","text":"internal function sandpaper:::check_pandoc() now points correct URL download RStudio, moved migration posit (@zkamvar, #471)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-12-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.12.0 (2023-05-19)","text":"Aggregate instructor notes now headings link back source instructor note (reported: @tobyhodges, #463; fixed: @zkamvar, #468) internal function sandpaper:::render_html() now explicitly sets pandoc version running subprocess. allows lesson developers use {pandoc} package set pandoc versions. (reported: @zkamvar, #465; fixed: @zkamvar, #465)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-12-0","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.12.0 (2023-05-19)","text":"Callout block anchor links now point correct ID block derived title block (opposed generic ID). (reported: @debpaul, https://github.com/datacarpentry/OpenRefine-ecology-lesson/issues/292 @bencomp, #454; fixed: @zkamvar, #467). Inline images longer automatically transform figure blocks (reported: @ostephens, #445; fixed: @zkamvar, #446). bug preventing image links (e.g. MyBinder badges) rendered links images . fixes issue. also helps distinguish inline images figures DOM.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-11-17","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.11.17 (2023-05-16)","text":"sandpaper::serve() gains quiet argument, defaulting TRUE interactive sessions FALSE command line sessions sandpaper::serve() gains ... argument pass options servr::server_config() setting ports hosts (reported: @twrightsman, https://github.com/carpentries/workbench/issues/50 #459; fixed: @zkamvar, #461).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-17","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.17 (2023-05-16)","text":"Break timing now included overall schedule. (reported: @karenword, #437; fixed: @bencomp, #455).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"test-suite-0-11-17","dir":"Changelog","previous_headings":"","what":"TEST SUITE","title":"sandpaper 0.11.17 (2023-05-16)","text":"upstream feature {renv}, forcing silent testing caused expectations fail. fixed specific tests turning verbosity tests (reported: @zkamvar, #457; fixed: @zkamvar, #458)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-16","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.16 (2023-05-05)","text":"failure incrementally build lesson sandpaper::serve() fixed (reported: @zkamvar, #450; fixed: @zkamvar, #451)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-11-16","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.11.16 (2023-05-05)","text":"Lessons markdown documents longer use callr::r() intermediary (reported: @zkamvar, #442, fixed: @zkamvar, #452)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-15","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.15 (2023-04-05)","text":"404 page now proper styling applied site deployed via one ci_ functions (reported: @zkamvar, #430; fixed: @zkamvar, #431). sandpaper::serve() longer error different directory used.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-14","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.14 (2023-04-04)","text":"404 page added (reported: @fmichonneau, #268; fixed: @zkamvar, #429)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-11-14","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.11.14 (2023-04-04)","text":"minimum version {pegboard} set 0.5.1","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"templates-0-11-14","dir":"Changelog","previous_headings":"","what":"TEMPLATES","title":"sandpaper 0.11.14 (2023-04-04)","text":"README, LICENSE, CONTRIBUTING, SETUP templates fixed work {pegboard} version 0.5.1 LICENSE CONTRIBUTING templates now refer Carpentries whole provides correct links community forums.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"workaround-0-11-13","dir":"Changelog","previous_headings":"","what":"WORKAROUND","title":"sandpaper 0.11.13 (2023-03-25)","text":"Fix issue {renv} version 0.17.2 unable provision packages used parent environment. problem environments version {sandpaper} controlled {renv}. (reported: https://github.com/rstudio/renv/issues/1177, @zkamvar; fixed #423, @zkamvar). Note fix applicable {renv} 0.17.2 fixed newer versions {renv}.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-11-12","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.11.12 (2023-03-22)","text":"workflow files now explicit permissions comment pull requests create new branches called. fixes issue new lessons ability preview pull requests update workflows. (reported: #420, @zkamvar; fixed #421, @zkamvar) create-pull-request action now coming fork Carpentries organisation security.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-11-12","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.11.12 (2023-03-22)","text":"typo fixed package cache vignette CONTRIBUTING boilerplate updated fix formatting issues","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-11","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.11 (2023-03-17)","text":"update_cache() now work {renv} version 0.17.1, lost print method renv_updates class (reported: @zkamvar, #415; fixed: @zkamvar, #416 https://github.com/zkamvar/vise/commit/ee4798701a958ee48429980eb970266885f8265b","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-11-11","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.11.11 (2023-03-17)","text":"@jcolomb added contributor DESCRIPTION.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-10","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.10 (2023-03-16)","text":"New lessons now provision learners/resources.md, allow glossary link work (reported: @elichad, #404 @ManonMarchand, https://github.com/carpentries/workbench-template-md/issues/20; fixed: @zkamvar, #410) default CONTRIBUTING file better suited Workbench longer references now-defunct lesson-example repository (reported fixed: @jcolomb, #407)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-9","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.9 (2023-03-14)","text":"Links assets instructor view longer render 404. (reported: @brownsarahm, #404; fixed: @zkamvar, #409)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-11-9","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.11.9 (2023-03-14)","text":"Lessons files spaces names (e.g learning tool) longer fail comment pull request previews (reported: @zkamvar, #399; fixed: @zkamvar, #400)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-8","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.8 (2023-03-09)","text":"Excessive output renv::diagnostics() building R Markdown documents suppressed.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-internal-fixes-0-11-7","dir":"Changelog","previous_headings":"","what":"MISC INTERNAL FIXES","title":"sandpaper 0.11.7 (2023-03-09)","text":"now build {sandpaper} development version {renv} avoid bugs come {renv} version 0.17.0. See #406 details. internal function message_package_cache() longer fails {renv} version 0.17.0.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-feature-0-11-6","dir":"Changelog","previous_headings":"","what":"NEW FEATURE","title":"sandpaper 0.11.6 (2023-02-15)","text":"blank character timing estimates (e.g. XX) now treated unknown estimate 5 minutes used missing element. warning issued listing episodes missing timings. (reported: @zkamvar, #395; fixed: @zkamvar, #396)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-6","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.6 (2023-02-15)","text":"manage_deps() now attempt recover errors “missing” bioconductor packages. Note provisional solution treats BioConductor packages afterthought. full fix {renv} bootstraps BioConductor repositories (reported: @zkamvar, #365 https://github.com/rstudio/renv/issues/1110; fixed: @zkamvar, #397)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-5","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.5 (2023-02-09)","text":"update_cache() pin_version() now find root path lesson checking manipulating dependencies. circumvent issue user accidentally create episodes/renv folder running update_cache() episodes/ directory (discovered: @sarahkaspar; reported: @zkamvar, #391; fixed: @zkamvar, #392).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-4","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.4 (2023-01-26)","text":"setup page always provisioned lessons regardless exists learners: field config.yaml (reported: @zkamvar, #386; fixed: @zkamvar #387).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"pandoc-0-11-4","dir":"Changelog","previous_headings":"","what":"PANDOC","title":"sandpaper 0.11.4 (2023-01-26)","text":"updates {sandaper} used pandoc version 3, longer implements pandoc.Null() constructor Lua filters (reported: @zkamvar, #380; fixed: @zkamvar: #385)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-11-3","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.11.3 (2022-12-16)","text":"Pull Request workflows now automatically cancel several commits sent succession. Specifically, workflows pr-recieve.yaml pr-comment.yaml given separate concurrency parameters based branch name pull request number. concurrencies prevent false alarms found https://github.com/carpentries/lesson-development-training/pull/165#issuecomment-1337182275. (discovered: @anenadic; reported: @zkamvar, #374; fixed: @zkamvar, #376)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-11-2","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.11.2 (2022-12-06)","text":"create_syllabus() function longer uses pkgdown::as_pkgdown() assumes flat file structure creating syllabus. provides fix #371. downlit shim updated modify function bodies preserving function signatures. workflows testing Windows fixed setting git config autocrlf false checkout (thanks @assignUser tip). test coverage workflow updated avoid long build times.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.1 (2022-12-05)","text":"bug deployment GitHub deployments fail due error says “Error: Can’t find DESCRIPTION” fixed (reported: @tobyhodges, #371; fixed, @zkamvar, #372)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-11-1","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.11.1 (2022-12-05)","text":"code inside main build_ functions cleaned . Unused variables removed narrative comments added provide context.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0110-2022-12-01","dir":"Changelog","previous_headings":"","what":"sandpaper 0.11.0 (2022-12-01)","title":"sandpaper 0.11.0 (2022-12-01)","text":"Documentation internal storage objects updated. Page progress indicators reflect estimated percentage progress lesson based timings recorded episode opposed fraction pages (reported: anonymous, #369; fixed @zkamvar, #370).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-10-8","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.10.8 (2022-11-15)","text":"schedule/syllabus timings now displayed XXh XXm clarify scope timing (requested: @tobyhodges, #361; fixed @zkamvar, #363). Documentation automated pull requests updated reflect bots public_repo scope.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-10-8","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.10.8 (2022-11-15)","text":"bug index page title instructor learner view fixed (reported: @tobyhodges, #361; fixed @zkamvar, #366)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-10-7","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.10.7 (2022-11-02)","text":"pandoc now set use default version r-lib/setup-pandoc (time update, version 2.19.2. Workflows update workflows packages now push single branches called update/workflows update/packages, respectively. avoid issue #350 Workflows longer use deprecated set-output command (reported: @zkamvar, #349; fixed @zkamvar, #356) Versions external actions updated include actions/core@1.10.0","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-10-6","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.10.6 (2022-10-25)","text":"Interactive functions modify lesson structure (move_episode(), set_episode(), etc) now display message user specify write = TRUE. message present command , executed, make desired change (requested: @tobyhodges, #345, fixed: @zkamvar, #352)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-10-5","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.10.5 (2022-10-24)","text":"source config parameter trailing / trimmed passed site URL two consectutive slashes.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-10-4","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.10.4 (2022-10-07)","text":"renv/sandbox longer required .gitignore. new bug introduced 0.10.2 caused lessons built 0.10.2 fail rebuilt CI. due assumption .gitignore item renv/sandbox strictly necessary clear method automatically update file like (reported: @zkamvar, #347; fixed: @zkamvar, #348).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-10-3","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.10.3 (2022-10-05)","text":"accidental commit sandpaper-version.txt version 0.8.0 inside workflow templates folder causing workflow update script create pull requests workflows every week much less frequent (irony commit trigger another pull request) (fixed: @zkamvar, #346).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-10-2","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.10.2 (2022-10-04)","text":"default .gitignore now renv/sandbox avoid sandbox directory tracked git. (see https://github.com/rstudio/renv/issues/1088) (reported: @zkamvar; #344, fixed: @zkamvar, #343)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-10-2","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.10.2 (2022-10-04)","text":"deploy-aws.yaml workflow removed plans use relegated beta stage workbench.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-10-1","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.10.1 (2022-09-28)","text":"index.md (Rmd) file title YAML element, take precedence default title “Summary Setup”. (requested: @SaraMorsy, #339; fixed: @zkamvar #342)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-10-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.10.1 (2022-09-28)","text":"Titles navigation bar now Markdown parsed correctly.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-10-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.10.0 (2022-09-19)","text":"default behavior create_episode() create_lesson() use episodes without numbered prefixes now automatically add episodes schedule (requested: @tobyhodges, #330; fixed @zkamvar, #333) New function move_episode() allows lesson contributor move episode schedule (requested: @tobyhodges, #330, fixed: @zkamvar, #333) New functions draft_lesson_md() draft_lesson_rmd() perform task create_lesson(add = FALSE). Helper function strip_prefix() automatically strip prefixes episodes schedule.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-10-0","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.10.0 (2022-09-19)","text":"get_config() now default path argument. bug anchors callout headings generic names (e.g. “discussion” “keypoints”) missing fixed.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-9-6","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.9.6 (2022-09-15)","text":"minor bug fixed. originated recent update {cli} newlines span collapsed. fix (reported: @zkamvar, #336; fixed @zkamvar #337)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-9-6","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.9.6 (2022-09-15)","text":"minimum version CLI updated version 3.4.0","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-9-6","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.9.6 (2022-09-15)","text":"Pull request response workflows updated make sure conditionals always default TRUE (see https://github.com/carpentries/actions/pull/56)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-095-2022-08-30","dir":"Changelog","previous_headings":"","what":"sandpaper 0.9.5 (2022-08-30)","title":"sandpaper 0.9.5 (2022-08-30)","text":"css js can now embedded individual pages custom styling (see https://bookdown.org/yihui/rmarkdown-cookbook/html-css.html implementation details). pandoc extension link_attributes added process custom link classes (see https://pandoc.org/MANUAL.html#extension-link_attributes details).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-094-2022-08-26","dir":"Changelog","previous_headings":"","what":"sandpaper 0.9.4 (2022-08-26)","title":"sandpaper 0.9.4 (2022-08-26)","text":"CLI styling important message {renv} fixed readable (reported: @zkamvar, #331; fixed: @zkamvar, #332). bioschemas metadata version updated 1.0 (reported: @zkamvar, #329; fixed @zkamvar, #332).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-9-3","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.9.3 (2022-08-12)","text":"test failing R-universe skipped documentation updated detail expected optional values config.yaml set_dropdown() template code conduct updated reflect style guide","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-9-2","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.9.2 (2022-08-09)","text":"version s3-sync action corrected. affects lessons deploy AWS","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-9-1","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.9.1 (2022-08-09)","text":"Anchor links now included sections callouts easy navigation sections. Thanks @fiveop @anenadic requesting feature. requested #285 https://github.com/carpentries/workbench/issues/28; fixed #325","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-9-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.9.0 (2022-07-12)","text":"set_config() gains option create, create new variables exist.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-9-0","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.9.0 (2022-07-12)","text":"new workflow called deploy-aws.yaml created deploy site AWS right secrets AWS available. workflow affect normal use, relegating patch release.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-8-0","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.8.0 (2022-07-06)","text":"new workflow called pr-preflight.yaml created perform quick pre-flight check pull request ensure malicious activity lesson , may look like modifying workflow lesson files pull request. lessons transition workbench styles official community-developed lessons, extra check added validate branch incoming PR contain invalid commits. Pull Request workflows simplified.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-7-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.7.1 (2022-07-05)","text":"bug fail_on_error defaulted true fixed. default false key present config.yaml (#314, @zkamvar).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-feature-0-7-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURE","title":"sandpaper 0.7.0 (2022-07-01)","text":"Placing fail_on_error: true config.yaml set global chunk option error = FALSE R Markdown documents, meaning error produced chunk, build fail unless chunk explicitly uses error = TRUE option. (requested: #306 @davidps, implemented: #310 @zkamvar)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-6-2","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.6.2 (2022-06-24)","text":"sidebar navigation mobile tablet views now includes information included navigation bar desktop mode. (reported: https://github.com/carpentries/workbench/issues/16#issuecomment-1165307355 @Athanasiamo #306, fixed: #309 @zkamvar) downit shims updated resiliant upstream changes","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-6-1","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.6.1 (2022-06-22)","text":"config.yaml template updated default incubator lessons helpful information included formatting (@tobyhodges, #302)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-6-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.6.0 (2022-06-10)","text":"create_lesson() gains rmd parameter, logical indicator lesson use R Markdown (TRUE default). FALSE, markdown lesson created package cache initialised. create_episode() gains ext parameter, allows users create plain markdown episodes need R Markdown functionality (see https://github.com/carpentries/sandpaper/issues/296).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-6-0","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.6.0 (2022-06-10)","text":"create_episode() now slugify titles contain lowercase ASCII letters, numbers UTF-8 characters words separated single hyphens (see https://github.com/carpentries/sandpaper/issues/294).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-6-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.6.0 (2022-06-10)","text":"internal check_episode() function removed - engineered marginal value.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-5-8","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.5.8 (2022-06-06)","text":"Running main workflow GitHub’s actions tab now uses checkbox indicate markdown file cache cleared. README file workflows longer contains link image exist.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-5-7","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.5.7 (2022-05-27)","text":"Workflows update lesson elements now report obvious summary next steps take invalid token (see https://github.com/carpentries/actions/pull/45)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-5-6","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.5.6 (2022-05-25)","text":"Pull requests now report elements lesson pass checks.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-5-5","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.5.5 (2022-05-23)","text":"New YAML items can now added -available varnish {{#yaml}} context. internal function set_dropdown() preserve yaml items explicitly coded config menu.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-5-4","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.5.4 (2022-05-18)","text":"build_episode_md() argument workenv now defaults globalenv() avoid S3 dispatch issues can occur new.env() (see https://github.com/carpentries/sandpaper/issues/288)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-5-3","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.5.3 (2022-05-18)","text":"Episodes ampersands titles longer break aggregate page building.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"temporary-bug-fix-0-5-2","dir":"Changelog","previous_headings":"","what":"TEMPORARY BUG FIX","title":"sandpaper 0.5.2 (2022-05-16)","text":"{downlit} shim updated longer fail parsing BASH globs. (see https://github.com/r-lib/downlit/pull/138)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-5-1","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.5.1 (2022-05-03)","text":"sidebar now enumerates episodes easier instructors learners indicate episode number instead name (suggested @fiveop #276). (@zkamvar, #277)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-suggests-0-5-1","dir":"Changelog","previous_headings":"","what":"NEW SUGGESTS","title":"sandpaper 0.5.1 (2022-05-03)","text":"{mockr} now suggested package (aka soft-dependency) facilitate testing functions need entire lesson set test functionality","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-5-1","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.5.1 (2022-05-03)","text":"setup-r setup-pandoc actions pinned version 2 setup-r action now uses default R installation GitHub’s runner, decreases build times ~ 1 minute. R actions use RStudio Package Manager, avoid overly lengthy build times. explicit permissions set deploy workflow (@zkamvar, #279)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-5-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.5.0 (2022-04-22)","text":"images.html built internal function build_images(), collecting images displaying alt text non-screen reader users (marking paragraphs aria-hidden screen reader users read twice). instructor-notes.html now built internal function build_instructor_notes() now collects instructor notes episodes section called aggregate-instructor-notes.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-5-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.5.0 (2022-04-22)","text":"internal build_agg_page() new argument, append, takes XPath expression node children appended. Defaults \"self::node()\". example alternate usage build_instructor_notes(), uses section[@id='aggregate-instructor-notes'].","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-4-1","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.4.1 (2022-04-21)","text":"One page Keypoints page redesigned. now use underlying internal function build_agg_page() (build aggregate page). allows slow templating processes performed cached instead repeated page. provides framework future aggregate pages (figures, instructor notes, glossary, etc). message now printed Keypoints --one pages written disk quiet = FALSE.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-4-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.4.0 (2022-04-13)","text":"--one page now available lesson websites /aio.html instructor/aio.html.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-4-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.4.0 (2022-04-13)","text":"Provisioning global lesson element cache (metadata, AST, global variables varnish) now executed via this_lesson(), run validate_lesson(). simplifies setup bit, provides method cache invalidation (checking git outputs) elements","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-3-6","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.3.6 (2022-04-09)","text":"custom sandpaper varnish engines properly linked footer lesson pages via version varnish 0.1.8. testthat tests updated. diagram vingettes updated reflect parallel roles sandpaper pegboard lesson.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-3-5","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.3.5 (2022-03-04)","text":"keypoints.html now rendered key-points.html fix navigation error varnish.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-3-4","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.3.4 (2022-03-02)","text":"pr-receive.yaml updated report errors workflow updates. See https://github.com/carpentries/sandpaper/issues/263 details","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-3-3","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.3.3 (2022-02-28)","text":"Links index page setup episodes now correctly render Links setup page now redirect index.html#setup (@zkamvar, #262) setup page now included instructor view schedule setup index page now separate section id “setup” schedule instructor index page now separate section id “schedule”","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-3-3","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.3.3 (2022-02-28)","text":"minimum version {varnish} required now 0.1.5","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-3-3","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.3.3 (2022-02-28)","text":"small bug update cache workflow caused silent error detremental effect fixed (@zkamvar, #250)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-3-2","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.3.2 (2022-02-25)","text":"minimum version {pegboard} least 0.2.3 accomodate div validation (@sstevens2, #259) minimuim version {varnish} least 1.5.0.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-3-1","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.3.1 (2022-02-23)","text":"Documents footnotes without trailing newlines now parse external links correctly adding newline document links.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-3-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.3.0 (2022-02-22)","text":"Common links markdown lessons can included via file top lesson called links.md. file exists, concatenated markdown file rendered HTML. Thanks @sstevens2 bringing feature (@zkamvar, #257) create_lesson() now includes links.md main directory. new help page called ?sandpaper.options provides documentation global options used sandpaper lesson (subject change).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-2-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.2.0 (2022-02-18)","text":"validate_lesson() perform checks links fenced divs lesson. now included calls build_lesson(), ci_deploy() serve() (@zkamvar, #255)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-2-0","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.2.0 (2022-02-18)","text":"minimum pegboard version now 0.2.0","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-2-0","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.2.0 (2022-02-18)","text":"internal function this_lesson() now properly invalidate reset change commit (e.g. lesson build switched).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-1-6","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.1.6 (2022-02-14)","text":"set_dropdown() longer fails {cli} version 3.2.0","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"internal-0-1-5","dir":"Changelog","previous_headings":"","what":"INTERNAL","title":"sandpaper 0.1.5 (2022-02-11)","text":"metadata now processed consistently across page types, first foremost reduces code complexity, second, allows rapid development future page types. instances, result marginal improvement build times, likely noticable.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-1-4","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.1.4 (2022-02-10)","text":"sandpaper::build_lesson() longer creates infinite loop called sandpaper::serve() (@zkamvar, #247)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-1-3","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.1.3 (2022-02-03)","text":"Clarify license information specify copyright held Carpentries","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-1-2","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.1.2 (2022-02-02)","text":"invalid sitemaps fixed correct namespace include slash site name. test requring pandoc 2.11 suppressed systems without version pandoc.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-1-1","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.1.1 (2022-02-01)","text":"{pegboard} package now required 0.1.0 greater due fix generating keypoints page (https://github.com/carpentries/pegboard/pull/76)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"metadata-0-1-1","dir":"Changelog","previous_headings":"","what":"METADATA","title":"sandpaper 0.1.1 (2022-02-01)","text":"metadata included lesson footer now correctly states @type TrainingMaterial (@zkamvar, #236) basic sitemap now constructed lesson (@zkamvar, #243)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-1-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.1.1 (2022-02-01)","text":"Empty pages longer throw errors rendering included output (@zkamvar, #237)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-1-0","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.1.0 (2022-02-01)","text":"internal function render_html() now passes --preserve-tabs parameter prevent pandoc removing educationally relevant information lessons. rebuilding lesson ci_deploy(..., rebuild = TRUE), detritus lesson site cleaned (@zkamvar, #91).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"breaking-changes-0-1-0","dir":"Changelog","previous_headings":"","what":"BREAKING CHANGES","title":"sandpaper 0.1.0 (2022-02-01)","text":"Add support updated frontend {varnish}. means need varnish 0.1.0 installed order use update. change includes modifications lua filters along general handling HTML elements means older versions varnish cease work. code blocks longer contain package links. links may handy sighted users explore documentation, may represent objstructions users rely screen-readers.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"instructor-view-0-1-0","dir":"Changelog","previous_headings":"","what":"INSTRUCTOR VIEW","title":"sandpaper 0.1.0 (2022-02-01)","text":"now two views lesson: instructor view learner view. biggest difference instructor view gains instructor-note sections (exist). Static pages view. means can toggle pages without needing javascript. Removed timings learner view (avoid discouraging learners) Setup page replaces schedule index page additional buttons included instructor view yet work, work point! downside moment building lesson takes bit longer due fact now render two pages change.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"navigation-0-1-0","dir":"Changelog","previous_headings":"","what":"NAVIGATION","title":"sandpaper 0.1.0 (2022-02-01)","text":"persistant sidebar links main content lesson present pages lesson. navigation bar prioritise items used frequently respective audiences: Learners: Key Points, Glossary, Learner Profiles, “Additional Information” (dropdown) Instructors: Key Points, Instructor Notes, Extract Images, “” (dropdown)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-1-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.1.0 (2022-02-01)","text":"build database now gains “date” column indicate date file last rendered markdown. allows “last updated ” better reflect state contents rendered files. default configuration file now includes keywords: item can place comma-separated list keywords include site’s metadata configuration file now also includes example provisioned navigation looks like default episode template now refers correct documentation links provides examples represent code blocks evaluated. setup page now contains structured example setup page shows provide dropdown menus different operating systems (@zkamvar, #28). user github PAT can detect name repository git setup, source goes example.com link.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9075","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9075","text":"Episodes missing timing metadata longer fail also contain questions objectives blocks. (@zkamvar, #222).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9074","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9074","text":"Internal function renv_cache_available() continues work {renv} 0.15.0. new version {renv} changed default value configuration setting system cache logical NULL, casued logical operation fail. (@zkamvar, #223)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependency-update-0-0-0-9073","dir":"Changelog","previous_headings":"","what":"DEPENDENCY UPDATE","title":"sandpaper 0.0.0.9073","text":"{renv} pinned version 0.14.0 version 0.13.2 throw error checking consent.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-function-0-0-0-9072","dir":"Changelog","previous_headings":"","what":"NEW FUNCTION","title":"sandpaper 0.0.0.9072","text":"serve() now allows work lesson automatically rebuild whenever save files disk.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-dependencies-0-0-0-9072","dir":"Changelog","previous_headings":"","what":"NEW DEPENDENCIES","title":"sandpaper 0.0.0.9072","text":"{servr} now used serve() function.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-feature-0-0-0-9071","dir":"Changelog","previous_headings":"","what":"NEW FEATURE","title":"sandpaper 0.0.0.9071","text":"Lesson blocks now treated blocks. placeholder us better test separation lesson veiw default learner view.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9070","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9070","text":"Lessons readonly zlib compressed files (read: git objects) can now websites built. (@zkamvar, #214)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9069","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9069","text":"build_handout() now officially exported function. pkgdown documentation updated","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9068","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9068","text":"Workflows updated use ubuntu-latest instead macOS-11. macOS runners often ~ 1 minute faster ubuntu runners, tradeoff potential failures packages available binary versions need compilation external C libraries (along runs failing due brew timeouts). update coincides update github actions, now check install ubuntu dependencies updating/installing packages. (@zkamvar, #184)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9067","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9067","text":"situation git fail remove everything fixed (#206, @zkamvar) Addressed CLI failures due glue version 1.5.0 (https://github.com/r-lib/cli/issues/370#issuecomment-965496848)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"api-change-0-0-0-9066","dir":"Changelog","previous_headings":"","what":"API CHANGE","title":"sandpaper 0.0.0.9066","text":"set_config() now takes named vector/list instead pair vectors.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9065","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9065","text":"set_config() set singular items configuration file (@zkamvar, #193)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9064","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9064","text":"Package discovery now respects lesson environment, unfixed 0.0.0.9063","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9063","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9063","text":"package cache can now built external {renv} environments (@zkamvar, #197).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9062","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9062","text":"New lessons specify custom titles reflected config file (@zkamvar, #195).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9061","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9061","text":"lessons colons title now correctly processed (@zkamvar, #192) code injection yaml now protected setting eval.expr = FALSE yaml parsing calls.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9060","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9060","text":"title lesson now appear index page.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9060","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9060","text":"translation script longer lives lesson repo moved (modified) https://data-lessons/lesson-transition/","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9059","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9059","text":"scheduler update-cache.yaml fixed run strictly first Tuesday month instead first seven days month Tuesdays.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9058","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9058","text":"update-cache.yaml simplified pull carpentries/actions repository now updates packages previously included lockfile (#185).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9057","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9057","text":"update-cache.yaml fixed regression introduced 4b8b14d088d03a8a9c6c90e974bb53c35691fb49 workflow run check repository beforehand.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9056","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9056","text":"update_github_workflows() now sets clean = \"*.yaml\" default align behavior GitHub workflow prevent stale workflows present repository. (#181, @zkamvar)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9055","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9055","text":"sandpaper-main.yaml pr-receive.yaml simplified using composite actions hosted carpentries/actions/setup-sandpaper carpentries/actions/setup-deps. caching mechanism R packages package cache can now reset modifying per-repository secret called CACHE_VERSION.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9055","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9055","text":"bug introduced 0.0.0.9054 dependencies discovered fixed.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9054","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9054","text":"manage_deps() runs slightly faster now longer runs renv::hydrate() new packages added lesson.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9053","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9053","text":"setting option(sandpaper.handout = TRUE) create code handout R lessons live /files/code-handout.R site.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9053","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9053","text":"internal caching mechanism added pegboard::Lesson objects use extracting components syllabus handout. See ?lesson_storage details.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9052","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9052","text":"pr-receive.yaml fixed spelling. pr-receive.yaml changed short-cut invalid PR messages longer build lesson PR invalid. Instead, emit warning message without building artifacts. pr-comment.yaml longer fail artifacts exist (cause extraneous emails users).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"documentation-0-0-0-9052","dir":"Changelog","previous_headings":"","what":"DOCUMENTATION","title":"sandpaper 0.0.0.9052","text":"Documentation test fixtures improved include branch functions.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9051","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9051","text":"template pull request message reverts back two-dot diff notation branches, temporary #169 can addressed. Linebreaks within paragraphs removed avoid github formatting linebreaks.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009050","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9050","title":"sandpaper 0.0.0.9050","text":"update {sandpaper} brings dependency management lessons generated content make collaboration lessons much easier less invasive establishing package cache lockfile via {renv} R package.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"introduction-0-0-0-9050","dir":"Changelog","previous_headings":"DEPENDENCY MANAGEMENT","what":"Introduction","title":"sandpaper 0.0.0.9050","text":"use {renv} package controlling dependency management lesson, contained {renv} profile called “lesson-requirements”. implemented profile instead default {renv} environment give maintainers flexibility whether want use package cache.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"consent-for-using-the-package-cache-0-0-0-9050","dir":"Changelog","previous_headings":"DEPENDENCY MANAGEMENT","what":"Consent for Using the Package Cache","title":"sandpaper 0.0.0.9050","text":"getOption('sandpaper.use_renv') set {sandpaper} loads detect contributor previously consented use {renv} package. TRUE, lesson use package cache, otherwise, lesson use default library. use_package_cache() give consent {sandpaper} create use package cache via {renv}. Internally, enforces options(sandpaper.use_renv = TRUE). no_package_cache() opposite use_package_cache() revokes consent use package cache lesson temporarily. can useful situtations cache mis-behaving want test lesson using newer set packages. Internally, enforces options(sandpaper.use_renv = FALSE). package_cache_trigger(TRUE) allows trigger full rebuild lockfile changes. set TRUE default ci_build_markdown()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"managing-the-package-cache-0-0-0-9050","dir":"Changelog","previous_headings":"DEPENDENCY MANAGEMENT","what":"Managing the Package Cache","title":"sandpaper 0.0.0.9050","text":"manage_deps() new function manage dependencies lesson. called create_lesson() build_markdown() ensure correct dependencies lesson installed. explicitly calls use_package_cache() runs. update_cache() bring updates lesson cache. pin_version() pin packages specific version, allowing authors upgrade downgrade packages .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9050","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9050","text":"create_lesson() now additionally create {renv} profile called “packages” lesson repository getOption('sandpaper.use_renv') TRUE. make lesson portable. index README files can now Rmd files (though recommended use .renvignore files avoid {sandpaper} becoming part package cache). internal function ci_deploy() set sandpaper.use_renv option TRUE build_markdown() thus build_lesson() now cache config.yaml renv.lock. longer step build process markdown files need rebuilt. cause project built previous versions sandpaper fully rebuilt. sandpaper_site() (thus, build_lesson()) now can take single file rendering render specific file regardless present cache without rendering files. addresses #77. (n.b. involved changes build_markdown(), build_site(), build_status()). varnish_vars() list contains commonly used variables lesson can contained config.yaml build_episode() build_home() now supply default variables varnish.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continous-integration-0-0-0-9050","dir":"Changelog","previous_headings":"","what":"CONTINOUS INTEGRATION","title":"sandpaper 0.0.0.9050","text":"unexported function ci_deploy() now automatically check set git user email. sandpaper-main.yaml pr-receive.yaml updated include {renv} cache, skip steps markdown lessons. update-cache.yaml new workflow update package cache lockfile create pull request trigger new builds lesson uses {renv}. update-workflows.yaml now produces informative instructions creating repository secret.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9050","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9050","text":"{callr} functions made non-anonymous moved separate file tested independently.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9050","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9050","text":"changes config.yaml now reflected lesson site without rebuilding (fixes #75) knitr option root.dir set output directory avoid generated content entering source.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009049","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9049","title":"sandpaper 0.0.0.9049","text":"placeholder testing 0.0.0.9050.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9048","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9048","text":"pandoc lua filter longer errors raw div HTML elements class (@zkamvar, #166)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9047","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9047","text":"update-workflows.yaml workflow now checks SANDPAPER_WORKFLOW secret valid. , provides instructions creating new secret.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9046","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9046","text":"Weekly run pull requests now default “weekly run” “triggered pull request”","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9045","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9045","text":"Weekly run added workflows action Actions updated reflect zkamvar -> carpenteries repository transfer (@zkamvar, #156)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"contiuous-integration-0-0-0-9044","dir":"Changelog","previous_headings":"","what":"CONTIUOUS INTEGRATION","title":"sandpaper 0.0.0.9044","text":"update-workflow.yaml parameters fixed use wildcards","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9044","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9044","text":"update_github_workflows() gains clean argument now print status reports end.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9043","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9043","text":"update-workflow.yaml workflow updated use github action hosted zkamvar/actions (soon transferred Carpentries account names actions displayed GitHub updated descriptive. script inst/scripts/update-workflows.sh removed favor github action.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9042","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9042","text":"experimental update-workflow.yaml workflow created create pull request update workflows. still experimental requires scoped repo scope, , nevertheless, concept currently valid.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9041","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9041","text":"fetch_github_workflows() renamed update_github_workflows() github workflows longer downloaded external source; now live inst/workflows. reduce internet connection requirements setting lesson testing sandpaper. create_lesson() now reports progress goes along tests updated use fixtures","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9040","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9040","text":"ci_deploy() gains reset argument, can used clear cache clean build lesson. ci_deploy() now uses ci_build_markdown() ci_build_site(), internally","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9039","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9039","text":"ci_session_info() report session information, help clean workflow files.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9038","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9038","text":"Fix broken deploy process continuous integration caused attempting fetch branches shallow clone (@zkamvar, #142)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9037","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9037","text":"Output ci_bundle_pr_artifacts() longer escapes HTML-like output diff summary. remove {xml2} explicit dependencies","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9036","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9036","text":"Documentation git_worktree_setup() added future versions maintainer future contributors. ci_bundle_pr_artifacts() new internal function create artifacts GitHub upload upon receipt pull request. replace clunky shell code lived inside YAML configuration file. (@zkamvar, #139) add {brio} soft dependencies (testing, maybe speed ???)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9035","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9035","text":"Tests git operations added robust (@zkamvar, #137) new test fixtures local remote repository added aid git tests.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9034","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9034","text":"Authors can now cross-link files within lesson appear lesson instead trying guess link appear website. example, wanted reference learners/setup.md episodes/introduction.md, write [setup](../learners/setup.md) automatically converted correct URL website (#43). still backwards compatible previous iteration writing flattened link (appear website).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9033","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9033","text":"get_drafts() report markdown files currently published lesson. Draft alert notifications controlled \"sandpaper.show_draft\" option. turn messages, use options(sandpaper.show_draft = FALSE) set_dropdown() family functions now throw error author attempts add file exist error occurr files listed config.yaml exist lesson informative message highlighting files missing.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9032","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9032","text":"internal get_resource_list() function modified incorporate features get_dropdown(). means get_dropdown() functions report files dropdown menus actually exist directory (#134). persistant test fixture now included speed testing time (#132 via #134)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9031","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9031","text":"{cli} package now official import package warning message issued internal warn_schedule() function changed exclusively use cli messages can suppressed suppressMessages(). internal sandpaper_cli_theme() used style CLI messages.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9030","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9030","text":"test caused problems new version {pegboard} fixed","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9029","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9029","text":"internal database updated use relative instead absolute paths. fixes #129","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-imports-0-0-0-9028","dir":"Changelog","previous_headings":"","what":"NEW IMPORTS","title":"sandpaper 0.0.0.9028","text":"{pingr} package now imported check online access, marginally decrease data usage (@fmichonneau, #127).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9027","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9027","text":"create_schedule() (internal function) longer uses pegboard’s extensions fixing reference links.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9026","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9026","text":"callout blocks headers greater h3 now rendered properly longer forced h3 tests now clean longer change working directory default {varnish} version bumped 0.0.0.9005 tests require pandoc skipped pandoc available tests presences multiple files use setequal instead equal allow alternate sorting orders.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependency-update-0-0-0-9025","dir":"Changelog","previous_headings":"","what":"DEPENDENCY UPDATE","title":"sandpaper 0.0.0.9025","text":"required {pegboard} bumped version 0.0.0.9014 {renv} {sessioninfo} added Suggested packages.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9024","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9024","text":"create_lesson() now enforce “main” default branch (init.defaultBranch set) default branch new lesson. also try make URL match project name user name (latter limited users GitHub PAT set {gh} recognises).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9023","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9023","text":"build_episode_md() now sets knitr.pandoc.knit option allow chunk option fig.cap rendered caption. fixes #114.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9023","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9023","text":"set_dropdown() now generalized set item dropdown menu (though likely wrapped better-named function generalized editing). system.file(\"transform.R\", pacakge = \"sandpaper\") points file used transforming styles-repo era lessons sandpaper lessons. read/write cycles reduced markdown generation longer interfering manipulation files stage (haven’t now).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9022","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9022","text":"build_markdown(rebuild = TRUE) now actually rebuilds lesson Changing episode suffix longer result build error. due build_markdown() trying clean building output instead . ’s situation throwing baby bathwater. case, fixes #102.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9021","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9021","text":"template initialized folders placeholders inside instructor/ profile/ menus. fixes #103.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9020","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9020","text":"set_*() functions longer mess yaml lists config.yaml. fixes #53.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009019","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9019","title":"sandpaper 0.0.0.9019","text":"required version {pegboard} bumped 0.0.0.9012, gives better error messages allows us read {sandpaper} lessons Lesson object.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009018","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9018","title":"sandpaper 0.0.0.9018","text":"episode template rearranged slightly given level 2 headers.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"engine-update-0-0-0-9017","dir":"Changelog","previous_headings":"","what":"ENGINE UPDATE","title":"sandpaper 0.0.0.9017","text":"version pandoc explicitly checked ensure version used least 2.11.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9016","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9016","text":"create_episode() make_prefix = FALSE longer create episodes prefixed - (see #93).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9015","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9015","text":"fetch_github_workflows() download update GitHub workflows Carpentries actions repository. update_varnish() download update {varnish} styling package local repository.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9014","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9014","text":"Episode order retained HTML navigation (#85) index.md recorded site/build/ directory, thus md-pages branch deployment.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"engine-update-0-0-0-9014","dir":"Changelog","previous_headings":"","what":"ENGINE UPDATE","title":"sandpaper 0.0.0.9014","text":"caching mechanism now similar {blogdown} database source files checksum hashes kept updated files built. provides two advantages, first longer peek top files check need updated second can keep files right order (see #85) Importantly, workflow affected, changes gets displayed github diff md-outputs branch.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9013","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9013","text":"RStudio, knit button works 🎉 (fix #77; @zkamvar, #82) sandpaper_site() site generator function allows {rmarkdown} use {sandpaper} machinery build site rmarkdown::render_site() build_site() gains slug argument tailors previewed content. create_lesson() now create blank index.md site: sandpaper_site YAML item. HTML accidentally rendered source directories silently removed site built. (fix #78, @zkamvar, #84)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9012","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9012","text":"Inline reference-based footnotes now supported.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9011","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9011","text":"Bare links text emoji (e.g. 😉) now rendered (fix #67). Objectives Questions headings now longer rendered (fix #64).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9010","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9010","text":"index.md exists top level, used instead README.md lesson index page (fix #56).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9009","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9009","text":"lua filter responsible creating Objectives summary block beginning episodes now uses native pandoc divs instead HTML block shims. ensures content corrupted pandoc’s section divs extension. addresses issue #64 aside elements forced level 3 headers (fixes issue pandocs –section-divs couldn’t understand HTML block contained start aside tag decided end section right . Objectives Questions blocks longer include headers initial summary block. bug introduced version 0.0.0.9008 fixed. bug improperly used regex resulting accidental removal cached rendered images. fixes issue #49 Rendered images now prefix {SOURCE}-rendered- site/built/fig/ subdir.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9008","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9008","text":"files removed source now also removed site/built directory. fixes issue #47","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009007","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9007","title":"sandpaper 0.0.0.9007","text":"HTML now processed pandoc lua filters following: overview block constructed teaching exercises metadata question objectives blocks instructor callout divs converted <aside> tags divs without H2 level headers automatically inserted divs incorrect level headers converted H2 divs list carpentries divs converted README updated reflect API changes","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009006","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9006","title":"sandpaper 0.0.0.9006","text":"Continuous integration functions added: ci_deploy() build markdown source site commit separate branches, including information source. ci_build_markdown() build markdown source files commit separate branch, including information source commit. ci_build_site() build site directly markdown branch, bypassing re-rendering markdown files. Miscellaneous additions {dovetail} longer suggests new internal function build_site() compartmentalizes conversion markdown html files folders named .git episodes directory copied website.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009005","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9005","title":"sandpaper 0.0.0.9005","text":"CODE_OF_CONDUCT.md learners/Setup.md instructors/ profiles/ LICENSE.md _schedule() functions renamed _episodes(). clean_*() functions now renamed reset_*() Generic set/get/reset_dropdown() functions created facilitate modification/access folders dropdown menus inside lesson questionable practices directories mucking . build_markdown() now generate artifacts site/built/assets/ directory instead episodes/ directory prevent generated artifacts included git (See https://github.com/carpentries/sandpaper/issues/24)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009004","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9004","title":"sandpaper 0.0.0.9004","text":"Internal html_from_md() renamed render_html() Internal build_episode() renamed build_episode_html() exported, documentation still internal Internal build_single_episode() renamed build_episode_md() exported, documentation still internal","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009003","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9003","title":"sandpaper 0.0.0.9003","text":"regression build_markdown() due called separate process fixed. Internal functions setting {knitr} options migrated live inside build_markdown()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009002","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9002","title":"sandpaper 0.0.0.9002","text":"Migrate template use fenced divs instead {dovetail}. build_lesson() now render HTML episode titles. {callr} now imported protect processes building markdown HTML files.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009001","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9001","title":"sandpaper 0.0.0.9001","text":"Add override argument build_lesson(). gets passed pkgdown::as_pkgdown() control site gets built. Update dependency {pegboard} 0.0.0.9006, includes $questions field make parsing ever shifting landscape bit easier. First tracking version NEWS","code":""}]
+[{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/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, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/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://carpentries.github.io/sandpaper/dev/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://carpentries.github.io/sandpaper/dev/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://carpentries.github.io/sandpaper/dev/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 [INSERT CONTACT METHOD]. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/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://carpentries.github.io/sandpaper/dev/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://carpentries.github.io/sandpaper/dev/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://carpentries.github.io/sandpaper/dev/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://carpentries.github.io/sandpaper/dev/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://carpentries.github.io/sandpaper/dev/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.0, available https://www.contributor-covenant.org/version/2/0/ 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://carpentries.github.io/sandpaper/dev/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to sandpaper","title":"Contributing to sandpaper","text":"outlines propose change sandpaper. detailed info contributing , tidyverse packages, please see development contributing guide.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to sandpaper","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to sandpaper","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees ’s needed. ’ve found bug, please file issue illustrates bug minimal reprex (also help write unit test, needed).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to sandpaper","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"\", fork = TRUE). Install development dependences devtools::install_dev_deps(), make sure package passes R CMD check running devtools::check(). R CMD check doesn’t pass cleanly, ’s good idea ask help continuing. Create Git branch pull request (PR). recommend using usethis::pr_init(\"brief-description--change\"). Make changes, commit git, create PR running usethis::pr_push(), following prompts browser. title PR briefly describe change. body PR contain Fixes #issue-number. user-facing changes, add bullet top NEWS.md (.e. just first header). Follow style described https://style.tidyverse.org/news.html.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to sandpaper","text":"New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat unit tests. Contributions test cases included easier accept.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to sandpaper","text":"Please note sandpaper project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2020 Carpentries Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/SUPPORT.html","id":null,"dir":"","previous_headings":"","what":"Getting help with sandpaper","title":"Getting help with sandpaper","text":"Thanks using sandpaper! filing issue, places explore pieces put together make process smooth possible.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/SUPPORT.html","id":"make-a-reprex","dir":"","previous_headings":"","what":"Make a reprex","title":"Getting help with sandpaper","text":"Start making minimal reproducible example using reprex package. haven’t heard used reprex , ’re treat! Seriously, reprex make R-question-asking endeavors easier (pretty insane ROI five ten minutes ’ll take learn ’s ). additional reprex pointers, check Get help! section tidyverse site.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/SUPPORT.html","id":"where-to-ask","dir":"","previous_headings":"","what":"Where to ask?","title":"Getting help with sandpaper","text":"Armed reprex, next step figure ask. ’s question: start community.rstudio.com, /StackOverflow. people answer questions. ’s bug: ’re right place, file issue. ’re sure: let community help figure ! problem bug feature request, can easily return report . opening new issue, sure search issues pull requests make sure bug hasn’t reported /already fixed development version. default, search pre-populated :issue :open. can edit qualifiers (e.g. :pr, :closed) needed. example, ’d simply remove :open search issues repo, open closed.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/SUPPORT.html","id":"what-happens-next","dir":"","previous_headings":"","what":"What happens next?","title":"Getting help with sandpaper","text":"efficient possible, development tidyverse packages tends bursty, shouldn’t worry don’t get immediate response. Typically don’t look repo sufficient quantity issues accumulates, ’s burst intense activity focus efforts. makes development efficient avoids expensive context switching problems, cost taking longer get back . process makes good reprex particularly important might multiple months initial report start working . can’t reproduce bug, can’t fix !","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/automated-pull-requests.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Working with Automated Pull Requests","text":"One innovations {sandpaper} ---box integration GitHub Actions supplying several workflows deploy, validate, update lesson. vignette focus latter set workflows: update lesson form. vignette, outline components lesson need updating, demonstrate pull requests requirements set non-carpentries account, demonstrate functions manually update components.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/automated-pull-requests.html","id":"components-which-need-to-be-updated","dir":"Articles","previous_headings":"","what":"Components which Need to be Updated","title":"Working with Automated Pull Requests","text":"concept {sandpaper} lesson simple: place set markdown R markdown files folder, run command, get website . ’s much different static site generator. makes different , {sandpaper} lesson, longer solely responsible ensuring styling build tools kept --date stripped repository separated three stand-alone packages. , however two places lesson build requirements still live need updating time time: Continuous Integration Workflows (.github/ folder) Lesson Requirements Generated Content (renv/ folder) lesson created {sandpaper} relies deployment workflows live inside .github/ folder ensure can properly deployed, also pull requests can tested validated. Additionally, lesson uses generated content via R Markdown, folder called renv/ repository. folder contain lockfile renv/profiles/lesson-requirements/renv.lock, detail packages required build lesson, along versions specific hash package contents.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/automated-pull-requests.html","id":"pull-request-updates","dir":"Articles","previous_headings":"","what":"Pull Request Updates","title":"Working with Automated Pull Requests","text":"host lesson one Carpentries’ repositories, automated workflows periodically check updates issue pull requests available updates. pull requests designed minimally invasive predictable ensure lesson remains --date. addition run periodically, can run time going repository > actions selecting one workflows starts “Maintain”. button says “Run Workflow” can push start process checking updates.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/automated-pull-requests.html","id":"weekly-checks-update-workflows","dir":"Articles","previous_headings":"Pull Request Updates","what":"Weekly Checks: Update Workflows","title":"Working with Automated Pull Requests","text":"weekly basis, workflow located .github/workflows/update-workflows.yaml run update workflow files current versions {sandpaper}. create pull request title “Update Workflows Version X.Y.Z” Carpentries Apprentice Bot. pull request created updates , otherwise, report updates time. Check make sure workflow contains modified workflows .github/workflows/ secrets accidentally divulged.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/automated-pull-requests.html","id":"monthly-checks-update-lesson-requirements","dir":"Articles","previous_headings":"Pull Request Updates","what":"Monthly Checks: Update Lesson Requirements","title":"Working with Automated Pull Requests","text":"monthly basis, lesson generated content, workflow .github/workflows/update-cache.yaml run check updates lockfile renv/profiles/lesson-requirements/renv.lock. pull request change renv.lock file report pull request packages changed. pull request followed closely comment inform changed generated content based new versions. packages relatively stable, much change. time inspect generated output errors occurr due packages updating expectations dependencies.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/automated-pull-requests.html","id":"setting-up-a-pull-request-bot","dir":"Articles","previous_headings":"Pull Request Updates","what":"Setting up a Pull Request Bot","title":"Working with Automated Pull Requests","text":"pull requests provided help Carpentries Apprentice Bot. bot available across Carpentries github organisations lesson hosted one organisations, need worry section. hosting lesson like take advantage periodic updates, necessarily need bot account, need access account following aspects Access lesson repository (collaborator self), Personal Access Token registered SANDPAPER_WORKFLOW repository public_repo workflow scopes","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/automated-pull-requests.html","id":"creating-a-pat","dir":"Articles","previous_headings":"Pull Request Updates > Setting up a Pull Request Bot","what":"Creating a PAT","title":"Working with Automated Pull Requests","text":"Whether choose use bot account account, need generate new Personal Access Token repo workflow scope. , add context Note field, set expiration date (default 30 days), scroll bottom page select “Generate Token” token appear green box start ghp_. Copy token clicking clipboard symbol immediately right token go repository > settings > secrets select “New Repository Secret” haven’t created SANDPAPER_WORKFLOW secret . Add SANDPAPER_WORKFLOW “Name” field paste token “Value” field.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/automated-pull-requests.html","id":"manual-updates","dir":"Articles","previous_headings":"","what":"Manual Updates","title":"Working with Automated Pull Requests","text":"want create updates manually without using GitHub Actions, two functions available: functions modify files locally like , can use git restore . revert original state.","code":"update_github_workflows() # updates the package workflows update_cache() # uses `renv::update()` to check for updates to the package cache"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/building-with-renv.html","id":"quickstart","dir":"Articles","previous_headings":"","what":"Quickstart","title":"Building Lessons With A Package Cache","text":"working lesson content generated output, guide . get started using local package cache separate default library lessons ensure can reproduce lesson locally. {sandpaper} engine mindful lessons generated content following ways: reliable setup: version lesson built carpentries website build computer packages identical environmentally friendly: lesson dependencies stored default R library alter R environment. transparent: additions deletions cache recorded lockfile, tracked git. get started, need explicitly give {sandpaper} permission create use cache function use_package_cache() NOTE: already used {renv} previously, get notification. Instead, get notification consent already provided. select 1 yes, global package cache created {renv} package sandpaper automatically detect install packages (updates) needed lesson. set cache, can used lessons going forward. example, let’s say lesson uses {cowsay} {curl} packages bring random cat fact end lesson: build lesson, see kind output: output use newly downloaded packages:","code":"library(\"sandpaper\") use_package_cache() #| #| ── Caching Build Packages for Generated Content ──────────────────────── #| The Carpentries lesson infrastructure uses the renv (R environment) #| package to maintain reproducibility for lessons with generated content. #| It looks like you have not yet used renv before, so this is a one-time #| message that gives you information about how the package cache can help #| you with your lesson. #| #| Finally, renv maintains a local cache of data on the filesystem, #| located at: #| #| - \"/path/to/cache\" #| #| This path can be customized: please see the documentation in #| `?renv::paths`. #| #| → This may take some time to set up the first time you use it, but once #| the cache is established, the process will run much more quickly. #| #| If you choose not to use the package cache, be aware that you may find #| differences between the lesson you render on your computer and what is #| rendered online. #| #| Do you want to using a package cache for Carpentries lessons? #| ── Enter your selection or press 0 to exit ───────────────────────────── #| 1: Yes, please use the package cache (recommended) #| 2: No, I want to use my default library ::::::::::::::::::::::::::::::::::::: keypoints - Use `.Rmd` files for lessons even if you don\"t need to generate any code - Run `sandpaper::check_lesson()` to identify any issues with your lesson - Run `sandpaper::build_lesson()` to preview your lesson locally :::::::::::::::::::::::::::::::::::::::::::::::: ```{r catfact, message=FALSE, echo=FALSE} library(curl) library(cowsay) say(\"catfact\", \"cat\") ``` build_lesson() #| ℹ Consent to use package cache provided #| → Searching for and installing available dependencies #| * Discovering package dependencies ... Done! #| * Copying packages into the library ... Done! #| * Resolving missing dependencies ... #| Retrieving \"https://cran.rstudio.com/src/contrib/cowsay_0.8.0.tar.gz\" ... #| OK [downloaded 564.5 Kb in 0.1 secs] #| Retrieving \"https://cran.rstudio.com/src/contrib/crayon_1.4.1.tar.gz\" ... #| OK [downloaded 34.9 Kb in 0.1 secs] #| Retrieving \"https://cran.rstudio.com/src/contrib/fortunes_1.5-4.tar.gz\" ... #| OK [downloaded 188.4 Kb in 0.1 secs] #| Retrieving \"https://cran.rstudio.com/src/contrib/rmsfact_0.0.3.tar.gz\" ... #| OK [downloaded 10.5 Kb in 0.1 secs] #| Installing crayon [1.4.1] ... #| OK [built from source] #| Copying crayon [1.4.1] into the cache ... #| OK [copied to cache in 5.9 milliseconds] #| Installing fortunes [1.5-4] ... #| OK [built from source] #| Copying fortunes [1.5-4] into the cache ... #| OK [copied to cache in 5.6 milliseconds] #| Installing rmsfact [0.0.3] ... #| OK [built from source] #| Copying rmsfact [0.0.3] into the cache ... #| OK [copied to cache in 5.7 milliseconds] #| Installing cowsay [0.8.0] ... #| OK [built from source] #| Copying cowsay [0.8.0] into the cache ... #| OK [copied to cache in 7.5 milliseconds] #| → Restoring any dependency versions #| * The library is already synchronized with the lockfile. #| → Recording changes in lockfile #| The following package(s) will be updated in the lockfile: #| #| # CRAN =============================== #| - cowsay [* -> 0.8.0] #| - crayon [* -> 1.4.1] #| - curl [* -> 4.3.2] #| - fortunes [* -> 1.5-4] #| - rmsfact [* -> 0.0.3] #| #| * Lockfile written to \"/path/to/lesson/renv/profiles/lesson-requirements/renv.lock\". #| ℹ Using package cache in /path/to/cache #| #| [ truncated ] ::::::::::::::::::::::::::::::::::::: keypoints - Use `.Rmd` files for lessons even if you don\"t need to generate any code - Run `sandpaper::check_lesson()` to identify any issues with your lesson - Run `sandpaper::build_lesson()` to preview your lesson locally :::::::::::::::::::::::::::::::::::::::::::::::: ```{.output} -------------- A cat can’t climb head first down a tree because every claw on a cat’s paw points the same way. To get down from a tree, a cat must back down. -------------- \\ \\ \\ |\\___/| ==) ^Y^ (== \\ ^ / )=*=( / \\ | | /| | | |\\ \\| | |_|/\\ jgs //_// ___/ \\_) ```"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/building-with-renv.html","id":"temporarily-turning-off-the-cache","dir":"Articles","previous_headings":"Quickstart","what":"Temporarily Turning Off the Cache","title":"Building Lessons With A Package Cache","text":"times might want use cache lesson. can use no_package_cache() lesson default using local library. output use packages available, throw errors exist: want turn , can use use_package_cache() Read information add, update, remove packages cache.","code":"no_package_cache() sandpaper:::build_markdown(rebuild = TRUE) #| ℹ Consent to use package cache not given. Using default library. #| → use `use_package_cache()` to enable the package cache for reproducible builds. #| → You can switch between using your cache and the default library with `options(sandpaper.use_renv = TRUE)` (`FALSE` for the default library) #| #| [ truncated ] ::::::::::::::::::::::::::::::::::::: keypoints - Use `.Rmd` files for lessons even if you don\"t need to generate any code - Run `sandpaper::check_lesson()` to identify any issues with your lesson - Run `sandpaper::build_lesson()` to preview your lesson locally :::::::::::::::::::::::::::::::::::::::::::::::: ```{.error} Error in library(cowsay): there is no package called \"cowsay\" ``` ```{.error} Error in say(\"catfact\", \"cat\"): could not find function \"say\" ``` use_package_cache() #| ℹ Consent for renv provided---consent for package cache implied."},{"path":"https://carpentries.github.io/sandpaper/dev/articles/building-with-renv.html","id":"motivation","dir":"Articles","previous_headings":"","what":"Motivation","title":"Building Lessons With A Package Cache","text":"One biggest motivations building lesson infrastructure around {sandpaper} mindful build lessons generated content. moment, explicitly R Markdown lessons, future, possible us expand different engines without changing lesson’s setup. past, ’ve done including script inside lesson template automatically scan dependencies lesson install computer. convenient, drawbacks method alter personal R library packages update, good using R work wanted preserve package versions . ‘renv’ package provides useful interface bring one aspect reproducibility R projects. people working Carpentries lessons also working academics likely projects computer package versions necessary work, ’s important environments respected. flavor renv applies package cache explicitly content lesson, impose default renv environment. provisioner following steps: check consent use package cache via ‘use_package_cache()’ prompt needed check profile created create needed via ‘renv::init()’ populate cache packages needed user’s system download missing via ‘renv::hydrate()’. includes new packages added lesson. lockfile already present, make sure packages cache aligned lockfile (downloading sources needed) via ‘renv::restore()’. Record state cache lockfile tracked git. include adding new packages removing old packages. ‘renv::snapshot()’ lockfile changes, see git power either commit restore changes.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/building-with-renv.html","id":"rebuild-with-the-package-cache","dir":"Articles","previous_headings":"","what":"Rebuild with the Package Cache","title":"Building Lessons With A Package Cache","text":"default, {sandpaper} rebuild files changed content. designed minmize time spent rebuilding lesson actively writing . using package cache, fact remain true even lockfile changes. , designed minimize time spent rebuilding lesson add unrelated, adjacent packages lesson. continuous integration (cloud deployment), change lockfile cause lesson rebuild make sure deployed version lesson matches source truth lockfile. function controls behavior called package_cache_trigger() call without arguments, report TRUE FALSE, indicating changes lockfile trigger rebuild , respectively: might want set TRUE pull changes upstream.","code":"package_cache_trigger() #| [1] FALSE package_cache_trigger(TRUE) # set the package cache to auto-trigger rebuilds #| [1] TRUE package_cache_trigger(FALSE) # prevent package cache from triggering rebuilds #| [1] FALSE"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/building-with-renv.html","id":"adding-new-packages-to-the-cache","dir":"Articles","previous_headings":"","what":"Adding New Packages to the Cache","title":"Building Lessons With A Package Cache","text":"{sandpaper} cache records packages needed repository . means want use package, must declared somewhere within lesson either library(package) package::function(). example, wanted use sessioninfo package create record end episode, need add following chunk: , {sandpaper} able detect package add cache. Note: {renv} can detect packages programmatically loaded, one workaround file called episodes/install.R lists installation scripts packages lesson want pin package specific version, read .","code":"```{r sessioninfo, echo = FALSE} sessioninfo::session_info() ```"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/building-with-renv.html","id":"pinning-specific-package-versions","dir":"Articles","previous_headings":"","what":"Pinning Specific Package Versions","title":"Building Lessons With A Package Cache","text":"pin specific package version (e.g. newest version breaking changes want work release), can use pin_version() function. example, ’s pin {cowsay} package version 0.7.0: record package lockfile next time manage_deps() runs, use correct version.","code":"pin_version(\"cowsay@0.7.0\")"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/building-with-renv.html","id":"updating-the-cache","dir":"Articles","previous_headings":"","what":"Updating the Cache","title":"Building Lessons With A Package Cache","text":"want update packages package cache, can use function update_cache(). requires internet connection scan packages lesson potential updates ask want update . update packages package cache lockfile.","code":"update_cache(prompt = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Data and Flow from Source to Website","text":"vignette designed R package developers looking understand data flows lesson source final website. assuming person reading familiarity R packaging R environments. One design philosophies Workbench lesson author contributor like add sort metadata modify setting given lesson, can editing source lesson need modify workflow.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"a-note-about-the-design","dir":"Articles","previous_headings":"Introduction","what":"A note about the design","title":"Data and Flow from Source to Website","text":"design much PDD (panic-driven design). okay wracking technical debt knew go back refactor got released. chance go back refactor, gladly . creation muliple storage objects using function factories knew time. now know might better use global environments instead. implementation originally done pull request #248, trying deduplicate code release version 0.1.0, massive push finally getting new website layout. flow data lay live package-level environment (even package-level R6 object) instead implemented function factories, ’s refactor another day another maintainer.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"two-sources-of-metadata","dir":"Articles","previous_headings":"Introduction","what":"Two Sources of Metadata","title":"Data and Flow from Source to Website","text":"Metadata different content , directly related content, extra information helps users site navigate content. example, episode page three piece metadata embedded YAML list top source file defines title along estimated time teaching excercises. terms lesson , metadata related whole lesson stored config.yaml. YAML file designed flat possible avoid common problems writing YAML. Metadata include things like title Lesson, source page lesson, time created, lesson program belongs . also defines optional parameters order episodes content can used customise lesson built. thing know metdata variables get passed {varnish} used control lesson website built along metadata.","code":"title: \"Introduction\" teaching: 5 exercises: 5 title: \"An Example Lesson\" carpentry: \"incubator\" created: \"2023-11-27\" life-cycle: \"pre-alpha\" episodes: - introduction.md - first-example.md handout: true"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"an-introduction-to-varnish","dir":"Articles","previous_headings":"Introduction","what":"An introduction to {varnish}","title":"Data and Flow from Source to Website","text":"order understand pass data config.yaml {varnish}, important first understand paradigm {sandpaper} {varnish} work together produce lesson website. Behind scenes, build markdown {knitr}, render raw HTML Pandoc use {pkgdown} insert HTML metadata template (written logicless templating language, Mustache) can updated modified independently {sandpaper}. template called {varnish}. paradigm {pkgdown}, HTML template split different components rendered separately combined single layout template. example, template defines layout: can see contains {{{ head }}}, {{{ header }}}, {{{ navbar }}}, {{{ content }}} {{{ footer }}}. results rendered templates. example, ’s head.html template, defines content goes HTML <head> tag (defining titles, metadata, stylesheets, JavaScript): templates used {varnish} take metadata one two sources: _pkgdown.yaml file defines global metadata like language (see pkgdown metadata section details. list values passed pkgdown::render_page() function. values can global local. get inserted template via pkgdown::render_page() function contents _pkgdown.yaml file inserted data list $yaml. challenge {sandpaper} : list per-lesson global variables need allocated build_lesson() run per-file variables need allocated every call build_html(). solution ’ve come store lists environments encapsulated function factories, detailed next section.","code":"<!-- START: inst/pkgdown/templates/layout.html --> <!-- Generated by pkgdown: do not edit by hand --> <!doctype html> <html lang=\"{{ lang }}\" data-bs-theme=\"auto\"> <head> {{{ head }}} <\/head> <body> {{{ header }}} <div class=\"container\"> <div class=\"row\"> {{{ navbar }}} {{{ content }}} <\/div><!--/div.row--> {{{ footer }}} {{! the end of div class container is in footer }} <\/body> <\/html> <!-- END: inst/pkgdown/templates/layout.html--> <meta charset=\"utf-8\"> <title>{{#site}}{{&title}}{{/site}}{{#pagetitle}}: {{&pagetitle}}{{/pagetitle}}<\/title> <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"> <script src=\"{{#site}}{{root}}{{/site}}assets/themetoggle.js\"><\/script> <link rel=\"stylesheet\" type=\"text/css\" href=\"{{#site}}{{root}}{{/site}}assets/styles.css\"> <script src=\"{{#site}}{{root}}{{/site}}assets/scripts.js\" type=\"text/javascript\"><\/script> <!-- mathjax --> <script type=\"text/x-mathjax-config\"> MathJax.Hub.Config({ config: [\"MMLorHTML.js\"], jax: [\"input/TeX\",\"input/MathML\",\"output/HTML-CSS\",\"output/NativeMML\", \"output/PreviewHTML\"], extensions: [\"tex2jax.js\",\"mml2jax.js\",\"MathMenu.js\",\"MathZoom.js\", \"fast-preview.js\", \"AssistiveMML.js\", \"a11y/accessibility-menu.js\"], TeX: { extensions: [\"AMSmath.js\",\"AMSsymbols.js\",\"noErrors.js\",\"noUndefined.js\"] }, tex2jax: { inlineMath: [['\\\\(', '\\\\)']], displayMath: [ ['$$','$$'], ['\\\\[', '\\\\]'] ], processEscapes: true } }); <\/script> <script src=\"https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js\" integrity=\"sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=\" crossorigin=\"anonymous\"><\/script> <!-- Responsive Favicon for The Carpentries --> <link rel=\"apple-touch-icon\" sizes=\"180x180\" href=\"{{#site}}{{root}}{{/site}}favicons/{{#yaml}}{{carpentry}}{{/yaml}}/apple-touch-icon.png\"> <link rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"{{#site}}{{root}}{{/site}}favicons/{{#yaml}}{{carpentry}}{{/yaml}}/favicon-32x32.png\"> <link rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"{{#site}}{{root}}{{/site}}favicons/{{#yaml}}{{carpentry}}{{/yaml}}/favicon-16x16.png\"> <link rel=\"manifest\" href=\"{{#site}}{{root}}{{/site}}favicons/{{#yaml}}{{carpentry}}{{/yaml}}/site.webmanifest\"> <link rel=\"mask-icon\" href=\"{{#site}}{{root}}{{/site}}favicons/{{#yaml}}{{carpentry}}{{/yaml}}/safari-pinned-tab.svg\" color=\"#5bbad5\"> <meta name=\"msapplication-TileColor\" content=\"#da532c\"> <meta name=\"theme-color\" media=\"(prefers-color-scheme: light)\" content=\"white\" /> <meta name=\"theme-color\" media=\"(prefers-color-scheme: dark)\" content=\"black\" />"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"storage-function-factories","dir":"Articles","previous_headings":"","what":"Storage Function Factories","title":"Data and Flow from Source to Website","text":"two types storage function factories {sandpaper}: Lesson Store (.lesson_store()) List Store (.list_store()). return lists functions access calling environments, created package loaded:","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"list-store","dir":"Articles","previous_headings":"Storage Function Factories","what":"List Store","title":"Data and Flow from Source to Website","text":"list store acts like persistent list get() set(), clear(), copy() update() methods.","code":"snd <- asNamespace(\"sandpaper\") this_list <- snd$.list_store() names(this_list) ## [1] \"get\" \"update\" \"set\" \"clear\" \"copy\" class(this_list) ## [1] \"list-store\" # to set a list, use a NULL key this_list$set(key = NULL, list( A = list(first = 1), B = list( C = list( D = letters[1:4], E = sqrt(2), F = TRUE ), G = head(sleep) ) )) # get the list this_list$get() ## $A ## $A$first ## [1] 1 ## ## ## $B ## $B$C ## $B$C$D ## [1] \"a\" \"b\" \"c\" \"d\" ## ## $B$C$E ## [1] 1.414214 ## ## $B$C$F ## [1] TRUE ## ## ## $B$G ## extra group ID ## 1 0.7 1 1 ## 2 -1.6 1 2 ## 3 -0.2 1 3 ## 4 -1.2 1 4 ## 5 -0.1 1 5 ## 6 3.4 1 6 # copy a list so that you can preserve the original list that_list <- this_list$copy() # update list elements by adding to them (note: vectors will be replaced) that_list$update(list(A = list(platform = \"MY COMPUTER\"))) that_list$get() ## $A ## $A$first ## [1] 1 ## ## $A$platform ## [1] \"MY COMPUTER\" ## ## ## $B ## $B$C ## $B$C$D ## [1] \"a\" \"b\" \"c\" \"d\" ## ## $B$C$E ## [1] 1.414214 ## ## $B$C$F ## [1] TRUE ## ## ## $B$G ## extra group ID ## 1 0.7 1 1 ## 2 -1.6 1 2 ## 3 -0.2 1 3 ## 4 -1.2 1 4 ## 5 -0.1 1 5 ## 6 3.4 1 6 # set nested list elements that_list$set(c(\"A\", \"platform\"), \"YOUR COMPUTER\") # note that modified copies do not modify the originals that_list$get()[[\"A\"]] ## $first ## [1] 1 ## ## $platform ## [1] \"YOUR COMPUTER\" this_list$get()[[\"A\"]] ## $first ## [1] 1"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"lesson-store","dir":"Articles","previous_headings":"Storage Function Factories","what":"Lesson Store","title":"Data and Flow from Source to Website","text":"creates object containing pegboard::Lesson object, can use extract episode-specific metadata along text questions. special object lesson set object, additionally set global data. {sandpaper} loaded, List Store Lesson Store objects created live {sandpaper} namespace long session active.","code":"snd <- asNamespace(\"sandpaper\") some_lesson <- snd$.lesson_store() names(some_lesson) ## [1] \"get\" \"valid\" \"set\" \"clear\""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"example","dir":"Articles","previous_headings":"","what":"Example","title":"Data and Flow from Source to Website","text":"metadata collected stored memory lesson built (triggered validate_lesson()), accessible via objects defined internal sandpaper:::set_globals(). set example lesson use demonstrate global variables. Please note using internal functions demonstration. internal functions guaranteed stable outside context {sandpaper}. Using asNamespace(\"sandpaper\") function allows create method accessing internal functions: Within {sandpaper}, environments contain metadata related whole lesson called .store, .resources, instructor_globals, learner_globals, this_metadata. lesson validated, values empty: contain following information: .store pegboard::Lesson object contains XML representation parsed Markdown source files this_metadata real computed metadata associated lesson along JSON-LD template generating metadata footer lesson. .resources list availabe files used build lesson order specified config.yaml instructor_globals pre-computed global data includes sidebar template, syllabus, dropdown menus, information packages used build lesson learner_globals instructor_globals, specifically learner view run validate_lesson() first time, metadata collected parsed config.yaml, individual episodes cached. validate_lesson() call pull cache .store exists valid (means nothing git changed). ’s valid exist, global storage initialised general cascade: Now variables called, can see information stored .","code":"library(\"sandpaper\") snd <- asNamespace(\"sandpaper\") # create a new lesson lsn <- create_lesson(tempfile(), name = \"An Example Lesson\", rstudio = TRUE, open = FALSE, rmd = FALSE) # add a new episode create_episode_md(title = \"First Example\", add = TRUE, path = lsn, open = FALSE) ## /tmp/RtmpercEqO/file2b422c29612b/episodes/first-example.md snd <- asNamespace(\"sandpaper\") class(snd$.store) ## [1] \"list\" print(snd$.store$get()) ## NULL class(snd$this_metadata) ## [1] \"list-store\" snd$this_metadata$get() ## list() class(snd$.resources) ## [1] \"list-store\" snd$.resources$get() ## list() class(snd$instructor_globals) ## [1] \"list-store\" snd$instructor_globals$get() ## list() class(snd$learner_globals) ## [1] \"list-store\" snd$learner_globals$get() ## list() # first run is always longer than the second system.time(validate_lesson(lsn)) ## ── Validating Fenced Divs ────────────────────────────────────────────── ## ── Validating Internal Links and Images ──────────────────────────────── ## user system elapsed ## 0.340 0.012 0.351 system.time(validate_lesson(lsn)) ## ── Validating Fenced Divs ────────────────────────────────────────────── ## ── Validating Internal Links and Images ──────────────────────────────── ## user system elapsed ## 0.100 0.008 0.108 ## validate_lesson() ## └─this_lesson() ## ├─.store$valid() ## │ ├─gert::git_diff() ## │ ├─gert::git_status() ## │ └─gert::git_log() ## ├─pegboard::Lesson$new() ## └─.store$set() ## └─set_globals() ## ├─initialise_metadata() ## │ ├─get_config() ## │ ├─template_metadata() ## │ └─this_metadata$set() ## ├─set_language() ## │ └─add_varnish_translations() ## │ └─tr_() ## │ └─these$translations ## ├─set_resource_list() ## │ ├─get_resource_list() ## │ │ └─get_config() ## │ └─.resources$set() ## ├─create_sidebar() ## ├─create_resources_dropdown() ## ├─learner_globals$set() ## └─instructor_globals$set()"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"lesson-storage","dir":"Articles","previous_headings":"","what":"Lesson Storage","title":"Data and Flow from Source to Website","text":"function stores pegboard::Lesson object responsible initialising resetting variable cache. can check cache needs reset using $valid() function inside object, checks git log, git status, git diff global check lesson contents. nothing changes, returns TRUE: However, update lesson contents way setting config variable, FALSE, indicating needs reset:","code":"snd <- asNamespace(\"sandpaper\") class(snd$.store) ## [1] \"list\" print(snd$.store$get()) ## <Lesson> ## Public: ## blocks: function (type = NULL, level = 0, path = FALSE) ## built: NULL ## challenges: function (path = FALSE, graph = FALSE, recurse = TRUE) ## children: NULL ## clone: function (deep = FALSE) ## episodes: list ## extra: list ## files: active binding ## get: function (element = NULL, collection = \"episodes\") ## handout: function (path = NULL, solution = FALSE) ## has_children: active binding ## initialize: function (path = \".\", rmd = FALSE, jekyll = TRUE, ...) ## isolate_blocks: function () ## load_built: function () ## n_problems: active binding ## overview: FALSE ## path: /tmp/RtmpercEqO/file2b422c29612b ## reset: function () ## rmd: FALSE ## sandpaper: TRUE ## show_problems: active binding ## solutions: function (path = FALSE) ## summary: function (collection = \"episodes\") ## thin: function (verbose = TRUE) ## trace_lineage: function (episode_path) ## validate_divs: function () ## validate_headings: function (verbose = TRUE) ## validate_links: function () ## Private: ## deep_clone: function (name, value) snd$.store$valid(lsn) ## [1] TRUE set_config(c(handout = TRUE), path = lsn, write = TRUE, create = TRUE) ## ℹ Writing to /tmp/RtmpercEqO/file2b422c29612b/config.yaml ## → NA -> handout: true snd$.store$valid(lsn) ## [1] FALSE snd$.store$set(lsn) snd$.store$valid(lsn) ## [1] TRUE"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"metadata","dir":"Articles","previous_headings":"","what":"Metadata","title":"Data and Flow from Source to Website","text":"metadata used store content config.yaml provide computed metadata lesson included footer JSON-LD object, useful indexing. Note metadata must duplicated page give correct URL identifiers. metadata rendered JSON-LD passed new variable {varnish} using internal fill_metadata_template() function:","code":"snd <- asNamespace(\"sandpaper\") snd$this_metadata$get() ## $carpentry ## [1] \"incubator\" ## ## $title ## [1] \"An Example Lesson\" ## ## $created ## [1] \"2024-11-07\" ## ## $keywords ## [1] \"software, data, lesson, The Carpentries\" ## ## $life_cycle ## [1] \"pre-alpha\" ## ## $license ## [1] \"CC-BY 4.0\" ## ## $source ## [1] \"https://github.com/carpentries/file2b422c29612b\" ## ## $branch ## [1] \"main\" ## ## $contact ## [1] \"team@carpentries.org\" ## ## $episodes ## [1] \"introduction.md\" \"first-example.md\" ## ## $metadata_template ## [1] \"{{=<% %>=}}\" ## [2] \"{\" ## [3] \" \\\"@context\\\": \\\"https://schema.org\\\",\" ## [4] \" \\\"@type\\\": \\\"TrainingMaterial\\\",\" ## [5] \" \\\"@id\\\": \\\"<% url %>\\\",\" ## [6] \" \\\"inLanguage\\\": \\\"<% lang %>\\\",\" ## [7] \" \\\"dct:conformsTo\\\": \\\"https://bioschemas.org/profiles/TrainingMaterial/1.0-RELEASE\\\",\" ## [8] \" \\\"description\\\": \\\"<% desc %><% ^desc %>A Carpentries Lesson teaching foundational data and coding skills to researchers worldwide<% /desc %>\\\",\" ## [9] \" \\\"keywords\\\": \\\"<% keywords %><% ^keywords %>software,data,lesson,The Carpentries<% /keywords %>\\\",\" ## [10] \" \\\"name\\\": \\\"<% &pagetitle %>\\\",\" ## [11] \" \\\"creativeWorkStatus\\\": \\\"active\\\",\" ## [12] \" \\\"url\\\": \\\"<% url %>\\\",\" ## [13] \" \\\"identifier\\\": \\\"<% url %>\\\",\" ## [14] \" <% #date %>\\\"dateCreated\\\": \\\"<% created %>\\\",\" ## [15] \" \\\"dateModified\\\": \\\"<% modified %>\\\",\" ## [16] \" \\\"datePublished\\\": \\\"<% published %>\\\"<% /date %>\" ## [17] \"}\" ## [18] \"<%={{ }}=%>\" ## ## $pagetitle ## [1] \"An Example Lesson\" ## ## $date ## $date$created ## [1] \"2024-11-07\" ## ## $date$modified ## [1] \"2024-11-07\" ## ## $date$published ## [1] \"2024-11-07\" ## ## ## $url ## [1] \"https://carpentries.github.io/file2b422c29612b/\" ## ## $citation ## [1] \"CITATION.cff\" ## ## $overview ## [1] FALSE ## ## $handout ## [1] TRUE writeLines(snd$fill_metadata_template(snd$this_metadata)) ## { ## \"@context\": \"https://schema.org\", ## \"@type\": \"TrainingMaterial\", ## \"@id\": \"https://carpentries.github.io/file2b422c29612b/index.html\", ## \"inLanguage\": \"en\", ## \"dct:conformsTo\": \"https://bioschemas.org/profiles/TrainingMaterial/1.0-RELEASE\", ## \"description\": \"A Carpentries Lesson teaching foundational data and coding skills to researchers worldwide\", ## \"keywords\": \"software, data, lesson, The Carpentries\", ## \"name\": \"An Example Lesson\", ## \"creativeWorkStatus\": \"active\", ## \"url\": \"https://carpentries.github.io/file2b422c29612b/index.html\", ## \"identifier\": \"https://carpentries.github.io/file2b422c29612b/index.html\", ## \"dateCreated\": \"2024-11-07\", ## \"dateModified\": \"2024-11-07\", ## \"datePublished\": \"2024-11-07\" ## }"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"lesson-resources-files","dir":"Articles","previous_headings":"","what":"Lesson Resources (files)","title":"Data and Flow from Source to Website","text":"next thing store globally resources use build lesson. allows us avoid needing constantly read file system:","code":"snd <- asNamespace(\"sandpaper\") snd$.resources$get() ## $. ## /tmp/RtmpercEqO/file2b422c29612b/CODE_OF_CONDUCT.md ## \"/tmp/RtmpercEqO/file2b422c29612b/CODE_OF_CONDUCT.md\" ## /tmp/RtmpercEqO/file2b422c29612b/LICENSE.md ## \"/tmp/RtmpercEqO/file2b422c29612b/LICENSE.md\" ## /tmp/RtmpercEqO/file2b422c29612b/config.yaml ## \"/tmp/RtmpercEqO/file2b422c29612b/config.yaml\" ## /tmp/RtmpercEqO/file2b422c29612b/index.md ## \"/tmp/RtmpercEqO/file2b422c29612b/index.md\" ## /tmp/RtmpercEqO/file2b422c29612b/links.md ## \"/tmp/RtmpercEqO/file2b422c29612b/links.md\" ## ## $episodes ## /tmp/RtmpercEqO/file2b422c29612b/episodes/introduction.md ## \"/tmp/RtmpercEqO/file2b422c29612b/episodes/introduction.md\" ## /tmp/RtmpercEqO/file2b422c29612b/episodes/first-example.md ## \"/tmp/RtmpercEqO/file2b422c29612b/episodes/first-example.md\" ## ## $instructors ## /tmp/RtmpercEqO/file2b422c29612b/instructors/instructor-notes.md ## \"/tmp/RtmpercEqO/file2b422c29612b/instructors/instructor-notes.md\" ## ## $learners ## /tmp/RtmpercEqO/file2b422c29612b/learners/reference.md ## \"/tmp/RtmpercEqO/file2b422c29612b/learners/reference.md\" ## /tmp/RtmpercEqO/file2b422c29612b/learners/setup.md ## \"/tmp/RtmpercEqO/file2b422c29612b/learners/setup.md\" ## ## $profiles ## /tmp/RtmpercEqO/file2b422c29612b/profiles/learner-profiles.md ## \"/tmp/RtmpercEqO/file2b422c29612b/profiles/learner-profiles.md\" ## ## $`renv/profiles/lesson-requirements` ## ## \"/tmp/RtmpercEqO/file2b422c29612b/renv/profiles/lesson-requirements/renv.lock\""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"global-and-local-variables","dir":"Articles","previous_headings":"","what":"Global and Local Variables","title":"Data and Flow from Source to Website","text":"rest global local variables recorded instructor_globals learner_globals. copied page updated local data (e.g. sidebar needs include headings current page).","code":"snd <- asNamespace(\"sandpaper\") snd$instructor_globals$get() ## $aio ## [1] TRUE ## ## $instructor ## [1] TRUE ## ## $sidebar ## [1] \"<div class=\\\"accordion accordion-flush\\\" id=\\\"accordionFlush1\\\">\\n <div class=\\\"accordion-item\\\">\\n <div class=\\\"accordion-header\\\" id=\\\"flush-heading1\\\">\\n <a href=\\\"index.html\\\">Summary and Schedule<\/a>\\n <\/div><!--/div.accordion-header-->\\n \\n <\/div><!--/div.accordion-item-->\\n<\/div><!--/div.accordion-flush-->\\n\" ## [2] \"<div class=\\\"accordion accordion-flush\\\" id=\\\"accordionFlush2\\\">\\n <div class=\\\"accordion-item\\\">\\n <div class=\\\"accordion-header\\\" id=\\\"flush-heading2\\\">\\n <a href='introduction.html'>1. introduction<\/a>\\n <\/div><!--/div.accordion-header-->\\n \\n <\/div><!--/div.accordion-item-->\\n<\/div><!--/div.accordion-flush-->\\n\" ## [3] \"<div class=\\\"accordion accordion-flush\\\" id=\\\"accordionFlush3\\\">\\n <div class=\\\"accordion-item\\\">\\n <div class=\\\"accordion-header\\\" id=\\\"flush-heading3\\\">\\n <a href='first-example.html'>2. First Example<\/a>\\n <\/div><!--/div.accordion-header-->\\n \\n <\/div><!--/div.accordion-item-->\\n<\/div><!--/div.accordion-flush-->\\n\" ## ## $more ## [1] \"<hr><li><a class='dropdown-item' href='reference.html'>Reference<\/a><\/li>\" ## ## $resources ## [1] \"<hr><li><a class='dropdown-item' href='reference.html'>Reference<\/a><\/li>\" ## ## $translate ## $translate$SkipToMain ## [1] \"Skip to main content\" ## ## $translate$iPreAlpha ## [1] \"Pre-Alpha\" ## ## $translate$PreAlphaNote ## [1] \"This lesson is in the pre-alpha phase, which means that it is in early development, but has not yet been taught.\" ## ## $translate$AlphaNote ## [1] \"This lesson is in the alpha phase, which means that it has been taught once and lesson authors are iterating on feedback.\" ## ## $translate$iAlpha ## [1] \"Alpha\" ## ## $translate$BetaNote ## [1] \"This lesson is in the beta phase, which means that it is ready for teaching by instructors outside of the original author team.\" ## ## $translate$iBeta ## [1] \"Beta\" ## ## $translate$PeerReview ## [1] \"This lesson has passed peer review.\" ## ## $translate$InstructorView ## [1] \"Instructor View\" ## ## $translate$LearnerView ## [1] \"Learner View\" ## ## $translate$MainNavigation ## [1] \"Main Navigation\" ## ## $translate$ToggleNavigation ## [1] \"Toggle Navigation\" ## ## $translate$ToggleDarkMode ## [1] \"Toggle theme (auto)\" ## ## $translate$Menu ## [1] \"Menu\" ## ## $translate$SearchButton ## [1] \"Search the All In One page\" ## ## $translate$Setup ## [1] \"Setup\" ## ## $translate$KeyPoints ## [1] \"Key Points\" ## ## $translate$InstructorNotes ## [1] \"Instructor Notes\" ## ## $translate$Glossary ## [1] \"Glossary\" ## ## $translate$LearnerProfiles ## [1] \"Learner Profiles\" ## ## $translate$More ## [1] \"More\" ## ## $translate$LessonProgress ## [1] \"Lesson Progress\" ## ## $translate$CloseMenu ## [1] \"close menu\" ## ## $translate$EPISODES ## [1] \"EPISODES\" ## ## $translate$Home ## [1] \"Home\" ## ## $translate$HomePageNav ## [1] \"Home Page Navigation\" ## ## $translate$RESOURCES ## [1] \"RESOURCES\" ## ## $translate$ExtractAllImages ## [1] \"Extract All Images\" ## ## $translate$AIO ## [1] \"See all in one page\" ## ## $translate$DownloadHandout ## [1] \"Download Lesson Handout\" ## ## $translate$ExportSlides ## [1] \"Export Chapter Slides\" ## ## $translate$PreviousAndNext ## [1] \"Previous and Next Chapter\" ## ## $translate$Previous ## [1] \"Previous\" ## ## $translate$EstimatedTime ## [1] \"Estimated time: {icons$clock} {minutes} minutes\" ## ## $translate$Next ## [1] \"Next\" ## ## $translate$NextChapter ## [1] \"Next Chapter\" ## ## $translate$LastUpdate ## [1] \"Last updated on {updated}\" ## ## $translate$EditThisPage ## [1] \"Edit this page\" ## ## $translate$ExpandAllSolutions ## [1] \"Expand All Solutions\" ## ## $translate$SetupInstructions ## [1] \"Setup Instructions\" ## ## $translate$DownloadFiles ## [1] \"Download files required for the lesson\" ## ## $translate$ActualScheduleNote ## [1] \"The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.\" ## ## $translate$BackToTop ## [1] \"Back To Top\" ## ## $translate$SpanToTop ## [1] \"<(Back)> To Top\" ## ## $translate$ThisLessonCoC ## [1] \"This lesson is subject to the <(Code of Conduct)>\" ## ## $translate$CoC ## [1] \"Code of Conduct\" ## ## $translate$EditOnGH ## [1] \"Edit on GitHub\" ## ## $translate$Contributing ## [1] \"Contributing\" ## ## $translate$Source ## [1] \"Source\" ## ## $translate$Cite ## [1] \"Cite\" ## ## $translate$Contact ## [1] \"Contact\" ## ## $translate$About ## [1] \"About\" ## ## $translate$MaterialsLicensedUnder ## [1] \"Materials licensed under {license} by the authors\" ## ## $translate$TemplateLicense ## [1] \"Template licensed under <(CC-BY 4.0)> by {template_authors}\" ## ## $translate$Carpentries ## [1] \"The Carpentries\" ## ## $translate$BuiltWith ## [1] \"Built with {sandpaper_link}, {pegboard_link}, and {varnish_link}\" ## ## $translate$ExpandAllSolutions ## [1] \"Expand All Solutions\" ## ## $translate$CollapseAllSolutions ## [1] \"Collapse All Solutions\" ## ## $translate$Collapse ## [1] \"Collapse\" ## ## $translate$Episodes ## [1] \"Episodes\" ## ## $translate$GiveFeedback ## [1] \"Give Feedback\" ## ## $translate$LearnMore ## [1] \"Learn More\" ## ## ## $sandpaper_version ## (0.16.10.9000) ## ## $sandpaper_cfg ## NULL ## ## $pegboard_version ## (0.7.7.9000) ## ## $pegboard_cfg ## [1] \"carpentries/pegboard/tree/fd1d354dee45f8398b365c1ee93d52d283172e84\" ## ## $varnish_version ## (1.0.5.9000) ## ## $varnish_cfg ## [1] \"carpentries/varnish/tree/eb621a78c21cf2d0584f08683ca4a3447f85efca\" ## ## $sandpaper_link ## <a href=\"https://github.com/carpentries/sandpaper\">sandpaper (0.16.10.9000)<\/a> ## ## $pegboard_link ## <a href=\"https://github.com/carpentries/pegboard/tree/fd1d354dee45f8398b365c1ee93d52d283172e84\">pegboard (0.7.7.9000)<\/a> ## ## $varnish_link ## <a href=\"https://github.com/carpentries/varnish/tree/eb621a78c21cf2d0584f08683ca4a3447f85efca\">varnish (1.0.5.9000)<\/a> ## ## $syllabus ## episode timings path percents ## introduction.md introduction 00h 00m introduction.html 0 ## first-example.md First Example 00h 12m first-example.html 50 ## Finish 00h 24m 100 ## questions ## introduction.md How do you write a lesson using R Markdown and `{sandpaper}`? ## first-example.md How do you write a lesson using R Markdown and `{sandpaper}`? ## ## ## $overview ## [1] FALSE snd$learner_globals$get() ## $aio ## [1] TRUE ## ## $instructor ## [1] FALSE ## ## $sidebar ## [1] \"<div class=\\\"accordion accordion-flush\\\" id=\\\"accordionFlush1\\\">\\n <div class=\\\"accordion-item\\\">\\n <div class=\\\"accordion-header\\\" id=\\\"flush-heading1\\\">\\n <a href=\\\"index.html\\\">Summary and Setup<\/a>\\n <\/div><!--/div.accordion-header-->\\n \\n <\/div><!--/div.accordion-item-->\\n<\/div><!--/div.accordion-flush-->\\n\" ## [2] \"<div class=\\\"accordion accordion-flush\\\" id=\\\"accordionFlush2\\\">\\n <div class=\\\"accordion-item\\\">\\n <div class=\\\"accordion-header\\\" id=\\\"flush-heading2\\\">\\n <a href='introduction.html'>1. introduction<\/a>\\n <\/div><!--/div.accordion-header-->\\n \\n <\/div><!--/div.accordion-item-->\\n<\/div><!--/div.accordion-flush-->\\n\" ## [3] \"<div class=\\\"accordion accordion-flush\\\" id=\\\"accordionFlush3\\\">\\n <div class=\\\"accordion-item\\\">\\n <div class=\\\"accordion-header\\\" id=\\\"flush-heading3\\\">\\n <a href='first-example.html'>2. First Example<\/a>\\n <\/div><!--/div.accordion-header-->\\n \\n <\/div><!--/div.accordion-item-->\\n<\/div><!--/div.accordion-flush-->\\n\" ## ## $more ## [1] \"<li><a class='dropdown-item' href='reference.html'>Reference<\/a><\/li>\" ## ## $resources ## [1] \"<li><a href='reference.html'>Reference<\/a><\/li>\" ## ## $translate ## $translate$SkipToMain ## [1] \"Skip to main content\" ## ## $translate$iPreAlpha ## [1] \"Pre-Alpha\" ## ## $translate$PreAlphaNote ## [1] \"This lesson is in the pre-alpha phase, which means that it is in early development, but has not yet been taught.\" ## ## $translate$AlphaNote ## [1] \"This lesson is in the alpha phase, which means that it has been taught once and lesson authors are iterating on feedback.\" ## ## $translate$iAlpha ## [1] \"Alpha\" ## ## $translate$BetaNote ## [1] \"This lesson is in the beta phase, which means that it is ready for teaching by instructors outside of the original author team.\" ## ## $translate$iBeta ## [1] \"Beta\" ## ## $translate$PeerReview ## [1] \"This lesson has passed peer review.\" ## ## $translate$InstructorView ## [1] \"Instructor View\" ## ## $translate$LearnerView ## [1] \"Learner View\" ## ## $translate$MainNavigation ## [1] \"Main Navigation\" ## ## $translate$ToggleNavigation ## [1] \"Toggle Navigation\" ## ## $translate$ToggleDarkMode ## [1] \"Toggle theme (auto)\" ## ## $translate$Menu ## [1] \"Menu\" ## ## $translate$SearchButton ## [1] \"Search the All In One page\" ## ## $translate$Setup ## [1] \"Setup\" ## ## $translate$KeyPoints ## [1] \"Key Points\" ## ## $translate$InstructorNotes ## [1] \"Instructor Notes\" ## ## $translate$Glossary ## [1] \"Glossary\" ## ## $translate$LearnerProfiles ## [1] \"Learner Profiles\" ## ## $translate$More ## [1] \"More\" ## ## $translate$LessonProgress ## [1] \"Lesson Progress\" ## ## $translate$CloseMenu ## [1] \"close menu\" ## ## $translate$EPISODES ## [1] \"EPISODES\" ## ## $translate$Home ## [1] \"Home\" ## ## $translate$HomePageNav ## [1] \"Home Page Navigation\" ## ## $translate$RESOURCES ## [1] \"RESOURCES\" ## ## $translate$ExtractAllImages ## [1] \"Extract All Images\" ## ## $translate$AIO ## [1] \"See all in one page\" ## ## $translate$DownloadHandout ## [1] \"Download Lesson Handout\" ## ## $translate$ExportSlides ## [1] \"Export Chapter Slides\" ## ## $translate$PreviousAndNext ## [1] \"Previous and Next Chapter\" ## ## $translate$Previous ## [1] \"Previous\" ## ## $translate$EstimatedTime ## [1] \"Estimated time: {icons$clock} {minutes} minutes\" ## ## $translate$Next ## [1] \"Next\" ## ## $translate$NextChapter ## [1] \"Next Chapter\" ## ## $translate$LastUpdate ## [1] \"Last updated on {updated}\" ## ## $translate$EditThisPage ## [1] \"Edit this page\" ## ## $translate$ExpandAllSolutions ## [1] \"Expand All Solutions\" ## ## $translate$SetupInstructions ## [1] \"Setup Instructions\" ## ## $translate$DownloadFiles ## [1] \"Download files required for the lesson\" ## ## $translate$ActualScheduleNote ## [1] \"The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.\" ## ## $translate$BackToTop ## [1] \"Back To Top\" ## ## $translate$SpanToTop ## [1] \"<(Back)> To Top\" ## ## $translate$ThisLessonCoC ## [1] \"This lesson is subject to the <(Code of Conduct)>\" ## ## $translate$CoC ## [1] \"Code of Conduct\" ## ## $translate$EditOnGH ## [1] \"Edit on GitHub\" ## ## $translate$Contributing ## [1] \"Contributing\" ## ## $translate$Source ## [1] \"Source\" ## ## $translate$Cite ## [1] \"Cite\" ## ## $translate$Contact ## [1] \"Contact\" ## ## $translate$About ## [1] \"About\" ## ## $translate$MaterialsLicensedUnder ## [1] \"Materials licensed under {license} by the authors\" ## ## $translate$TemplateLicense ## [1] \"Template licensed under <(CC-BY 4.0)> by {template_authors}\" ## ## $translate$Carpentries ## [1] \"The Carpentries\" ## ## $translate$BuiltWith ## [1] \"Built with {sandpaper_link}, {pegboard_link}, and {varnish_link}\" ## ## $translate$ExpandAllSolutions ## [1] \"Expand All Solutions\" ## ## $translate$CollapseAllSolutions ## [1] \"Collapse All Solutions\" ## ## $translate$Collapse ## [1] \"Collapse\" ## ## $translate$Episodes ## [1] \"Episodes\" ## ## $translate$GiveFeedback ## [1] \"Give Feedback\" ## ## $translate$LearnMore ## [1] \"Learn More\" ## ## ## $sandpaper_version ## (0.16.10.9000) ## ## $sandpaper_cfg ## NULL ## ## $pegboard_version ## (0.7.7.9000) ## ## $pegboard_cfg ## [1] \"carpentries/pegboard/tree/fd1d354dee45f8398b365c1ee93d52d283172e84\" ## ## $varnish_version ## (1.0.5.9000) ## ## $varnish_cfg ## [1] \"carpentries/varnish/tree/eb621a78c21cf2d0584f08683ca4a3447f85efca\" ## ## $sandpaper_link ## <a href=\"https://github.com/carpentries/sandpaper\">sandpaper (0.16.10.9000)<\/a> ## ## $pegboard_link ## <a href=\"https://github.com/carpentries/pegboard/tree/fd1d354dee45f8398b365c1ee93d52d283172e84\">pegboard (0.7.7.9000)<\/a> ## ## $varnish_link ## <a href=\"https://github.com/carpentries/varnish/tree/eb621a78c21cf2d0584f08683ca4a3447f85efca\">varnish (1.0.5.9000)<\/a> ## ## $overview ## [1] FALSE"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"translations","dir":"Articles","previous_headings":"Global and Local Variables","what":"Translations","title":"Data and Flow from Source to Website","text":"majority {varnish} templates keys need translations format {{ translate.ThingInPascalCase }}: variables {sandpaper} expected exist. expected exist, theese variables generated stored internal environment $translations function establish_translation_vars() package loaded. lesson validated, variables translated correct language set_language() placed instructor_globals learner_globals storage. variables passed directly {varnish} templates, eventually get processed {whisker}: key building lessons languages, regardless default language. lesson author sets lang: config key two-letter language code lesson written . gets passed set_language() function, modifies translations inside global data, modify language user session: Switching language controlled entirely within lesson config:","code":"<!-- START: inst/pkgdown/templates/content-syllabus.html --> <div class=\"col-xl-12 col-lg-12\"> <main id=\"main-content\" class=\"main-content\"> <h1>{{& pagetitle }}<\/h1> <div class=\"container lesson-content\"> <p> {{# translate.LastUpdate }} {{& translate.LastUpdate }} |{{/ translate.LastUpdate }} <a href=\"{{#yaml}}{{source}}/edit/{{branch}}/{{/yaml}}{{file_source}}{{^file_source}}index.md{{/file_source}}\"> {{ translate.EditThisPage }} <i aria-hidden=\"true\" data-feather=\"edit\"><\/i> <\/a> <\/p> {{& readme }} {{#syllabus}} <section id=\"schedule\"> <table class=\"table schedule table-striped\" role=\"presentation\"> <tbody> {{#setup}} <tr> <td><\/td><td><a href=\"#setup\">{{ translate.SetupInstructions }}<\/a><\/td><td> {{ translate.DownloadFiles }}<\/td> <\/tr> {{/setup}} {{& syllabus }} <\/table> <p> {{ translate.ActualScheduleNote }} <\/p> <\/section> {{/syllabus}} {{#setup}} <section id=\"setup\"> {{{setup}}} <\/section> {{/setup}} <\/main> <\/div> <!-- END : inst/pkgdown/templates/content-syllabus.html --> snd <- asNamespace(\"sandpaper\") whisker::whisker.render(\"Edit this page: {{ translate.EditThisPage }}\", data = snd$instructor_globals$get() ) ## [1] \"Edit this page: Edit this page\" snd <- asNamespace(\"sandpaper\") snd$set_config(c(lang = \"es\"), path = lsn, create = TRUE, write = TRUE) ## ℹ Writing to /tmp/RtmpercEqO/file2b422c29612b/config.yaml ## → NA -> lang: 'es' snd$this_lesson(lsn) whisker::whisker.render(\"Edit this page: {{ translate.EditThisPage }}\", data = snd$instructor_globals$get() ) ## [1] \"Edit this page: Mejora esta página\" Sys.getenv(\"LANGUAGE\") ## [1] \"en\" snd$set_config(c(lang = \"en\"), path = lsn, create = TRUE, write = TRUE) ## ℹ Writing to /tmp/RtmpercEqO/file2b422c29612b/config.yaml ## → lang: 'es' -> lang: 'en' snd$this_lesson(lsn) whisker::whisker.render(\"Edit this page: {{ translate.EditThisPage }}\", data = snd$instructor_globals$get() ) ## [1] \"Edit this page: Edit this page\""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"translation-variables","dir":"Articles","previous_headings":"Global and Local Variables","what":"Translation Variables","title":"Data and Flow from Source to Website","text":"62 translations generated set_language() correspond following variables varnish: addition, 27 translations inserted get varnish:","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/data-flow.html","id":"pkgdown-metadata","dir":"Articles","previous_headings":"","what":"pkgdown metadata","title":"Data and Flow from Source to Website","text":"Another source metadata created pkgdown file called site/_pkgdown.yaml. file allows {pkgdown} recognise website needs built. variables compiled pkg variable passed downstream files build_site(). important elements use $lang stores language variable $src_path stores source path lesson (site/ directory, location SANDPAPER_SITE environment variable). $dst_path stores destination path lesson (site/docs). NOTE: particular path changed build_site() update name path ’s less confusing. docs folder mechanism pkgdown locally deploy site without affect package structure (also mechanism serve GitHub pages past). $meta list items passed {varnish} sent rendered, goes one transformation, variable contexts find {varnish} come . contexts use site root path title, yaml lesson-wide content, lang define language. Everything else used.","code":"# ------------------------------------------------------------------ information # This file was generated by sandpaper version '0.16.10.9000' # If you want to make changes, please edit '/tmp/RtmpercEqO/file2b422c29612b/config.yaml' # ------------------------------------------------------------------ information title: An Example Lesson lang: en home: title: Home strip_header: yes description: ~ template: package: varnish params: time: 2024-11-07 18:55:57 +0000 source: https://github.com/carpentries/file2b422c29612b branch: main contact: team@carpentries.org license: CC-BY 4.0 handout: ~ cp: no lc: no dc: no swc: no carpentry: incubator carpentry_name: Carpentries Incubator carpentry_icon: incubator life_cycle: pre-alpha pre_alpha: yes alpha: no beta: no stable: no doi: ~ title: An Example Lesson created: '2024-11-07' keywords: software, data, lesson, The Carpentries episodes: ~ learners: ~ instructors: ~ profiles: ~ snd <- asNamespace(\"sandpaper\") pkg <- pkgdown::as_pkgdown(snd$path_site(lsn)) pkg[c(\"lang\", \"src_path\", \"dst_path\", \"meta\")] ## $lang ## [1] \"en\" ## ## $src_path ## /tmp/RtmpercEqO/file2b422c29612b/site ## ## $dst_path ## /tmp/RtmpercEqO/file2b422c29612b/site/docs ## ## $meta ## $meta$title ## [1] \"An Example Lesson\" ## ## $meta$lang ## [1] \"en\" ## ## $meta$home ## $meta$home$title ## [1] \"Home\" ## ## $meta$home$strip_header ## [1] TRUE ## ## $meta$home$description ## NULL ## ## ## $meta$template ## $meta$template$package ## [1] \"varnish\" ## ## $meta$template$params ## $meta$template$params$time ## [1] \"2024-11-07 18:55:57 +0000\" ## ## $meta$template$params$source ## [1] \"https://github.com/carpentries/file2b422c29612b\" ## ## $meta$template$params$branch ## [1] \"main\" ## ## $meta$template$params$contact ## [1] \"team@carpentries.org\" ## ## $meta$template$params$license ## [1] \"CC-BY 4.0\" ## ## $meta$template$params$handout ## NULL ## ## $meta$template$params$cp ## [1] FALSE ## ## $meta$template$params$lc ## [1] FALSE ## ## $meta$template$params$dc ## [1] FALSE ## ## $meta$template$params$swc ## [1] FALSE ## ## $meta$template$params$carpentry ## [1] \"incubator\" ## ## $meta$template$params$carpentry_name ## [1] \"Carpentries Incubator\" ## ## $meta$template$params$carpentry_icon ## [1] \"incubator\" ## ## $meta$template$params$life_cycle ## [1] \"pre-alpha\" ## ## $meta$template$params$pre_alpha ## [1] TRUE ## ## $meta$template$params$alpha ## [1] FALSE ## ## $meta$template$params$beta ## [1] FALSE ## ## $meta$template$params$stable ## [1] FALSE ## ## $meta$template$params$doi ## NULL ## ## $meta$template$params$title ## [1] \"An Example Lesson\" ## ## $meta$template$params$created ## [1] \"2024-11-07\" ## ## $meta$template$params$keywords ## [1] \"software, data, lesson, The Carpentries\" ## ## $meta$template$params$episodes ## NULL ## ## $meta$template$params$learners ## NULL ## ## $meta$template$params$instructors ## NULL ## ## $meta$template$params$profiles ## NULL dat <- pkgdown::data_template(pkg) writeLines(yaml::as.yaml(dat[c(\"lang\", \"site\", \"yaml\")])) ## lang: en ## site: ## root: '' ## title: An Example Lesson ## yaml: ## time: 2024-11-07 18:55:57 +0000 ## source: https://github.com/carpentries/file2b422c29612b ## branch: main ## contact: team@carpentries.org ## license: CC-BY 4.0 ## handout: ~ ## cp: no ## lc: no ## dc: no ## swc: no ## carpentry: incubator ## carpentry_name: Carpentries Incubator ## carpentry_icon: incubator ## life_cycle: pre-alpha ## pre_alpha: yes ## alpha: no ## beta: no ## stable: no ## doi: ~ ## title: An Example Lesson ## created: '2024-11-07' ## keywords: software, data, lesson, The Carpentries ## episodes: ~ ## learners: ~ ## instructors: ~ ## profiles: ~ ## .present: yes"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/deployment.html","id":"why-r-markdown","dir":"Articles","previous_headings":"","what":"Why R Markdown?","title":"Building and Deployment of a {sandpaper} lesson","text":"decided using R Markdown format powerful tool allows write code text without copy paste output/images/tables. support several languages including python, BASH, SQL. importantly: code rendering features purely optional; can strip away R-associated content left markdown document. system already used R lessons several years works fairly well.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/deployment.html","id":"the-two-step-building-locally","dir":"Articles","previous_headings":"","what":"The Two-Step: Building Locally","title":"Building and Deployment of a {sandpaper} lesson","text":"preview lessons, build static files locally, without servers. possible go directly R Markdown HTML, use two-step process: Generate static markdown source files hash original file YAML header Using external style template, generate website HTML built markdown files NOTE: need make sure renv environment defined lessons, think need happen things released CRAN avoid maxing github api requests. Now, first reaction may , “need two step process can generate HTML directly R Markdown?” answer three-fold. First, R code R Markdown document, takes time execute code add output document. intermediate markdown document contains hash original document, can make sure build files changed content minimal overhead manner compatible R Markdown’s chunk caching feature. Second, generated element page creates invalid HTML, usually causes cascading effect can hard track looking raw HTML output. markdown intermediate allows us easily single potential problems. particular reason important next section scheduled deployments avoid problems raised explicitly checking output. Third, rendered markdown documents makes easy use HTML pandoc templates provided Carpentries. might also wondering “aren’t rendered markdown HTML files tracked git?” answer , , just computer.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/deployment.html","id":"i-deployment-github","dir":"Articles","previous_headings":"","what":"[i] Deployment (GitHub)","title":"Building and Deployment of a {sandpaper} lesson","text":"lesson content auto-generated ecosystem software constantly evolving, ’s important make sure things true: website always available (barring blackouts GitHub) style lessons can updated fly. output lessons match maintainers expect. Changes lesson output easily auditable via git diff. two sources entropy (software environment needed build lesson content CSS/HTML/JS needed create website), ’s important separate steps failure, separate allows us audit failure fix issue appropriate end. Thus, use two-step system presented earlier local rendering, weekly monthly checks: Zooming Pull request workflow can see one point entry. box elements represent user interactions, ellipses GitHub workflows. color indicates permission levels workflows. Lavender workflows ability check code compare . Wheat/yellow colored workflows full permissions push repository: track source files lesson output maintainer’s computer, need rely Continuous Integration rebuild lesson deploy cloud. still use two-step process , difference don’t want make extra commits main branch, instead creating commits two extra directories, create orphan branches called md-sources gh-pages. latter familiar lesson maintainers, former serves staging evaluation area changes generated content. Takeaway diagram: Yes, complex, modularity ensures can replace components without needing significantly modify components. diagram describes dependency graph lesson template. component graph represents either file (beige files/folders/documents) tools (boxes). edges (lines connecting components) categorized following labels: depends (e.g. -> b means component depends component b). usually reserved lesson artifacts generated markdown HTML. component dependent another component, means can exist without upstream component. Changes upstream component can happen independently downstream component, changes affect state downstream component. uses (e.g. -> b means component uses aspects component b). relationship, components independent can change independent one another without necessarily affecting state . contains (e.g. -> b means component contains component b). component contains another component must change contained component changes. example, changes package cache lockfile requires corresponding commit source files. modifies (e.g. -> b means component modifies component b). Modification occurs component agent change downstream component, changes upstream component necessarily correspond change downstream component. example GitHub Actions component one graph can modify components (including ), undergo change update frequency, necessarily affect changes downstream components see.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/deployment.html","id":"push-to-main-branch","dir":"Articles","previous_headings":"[i] Deployment (GitHub)","what":"Push to main branch","title":"Building and Deployment of a {sandpaper} lesson","text":"time commit pushed main branch, command sandpaper::ci_deploy() run GitHub actions render changed source files main md-source apply HTML template, {varnish} files md-source create website. process assumes pushes main branch break rendering process either cosmetic changes changes come pull requests (previously vetted). extra maintainer interaction required.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/deployment.html","id":"pull-requests","dir":"Articles","previous_headings":"[i] Deployment (GitHub)","what":"Pull requests","title":"Building and Deployment of a {sandpaper} lesson","text":"time pull request added, maintainer informed changes lesson (anything), process goes like : pull request triggers new branch md-sources called md-sources-{pr#}. PR built md-sources-{pr#} diff md-sources-{pr#} md-sources added PR comments link. additional commits PR branch rebuilt changes amended md-sources-{pr#} branch (effectively, squash merge) maintainer approves changes, PR gets merged master, site rebuilt source, pr branch removed.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/deployment.html","id":"cron-weekly-updating-the-html-templates","dir":"Articles","previous_headings":"[i] Deployment (GitHub)","what":"CRON: weekly (updating the HTML templates)","title":"Building and Deployment of a {sandpaper} lesson","text":"mentioned , HTML templates live within lesson repository. live {varnish} package applied rendered markdown files. step start md-source branch re-apply fresh version template bring stylistic changes occurred {varnish} repository (e.g. new CSS rules) previous week. step test HTML template working correctly. error occurs, know need fix HTML template lesson. maintainer interaction required.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/deployment.html","id":"cron-monthly-keeping-software-current","dir":"Articles","previous_headings":"[i] Deployment (GitHub)","what":"CRON: monthly (keeping software current)","title":"Building and Deployment of a {sandpaper} lesson","text":"weekly CRON jobs ensure HTML template works, run monthly jobs make sure software stack continues work expected. important making sure generated output matches output learners see narrative additionally matches output. explicitly test changes lesson due changes software stack HTML template. many changes produce technically valid output, Manual inspection diffs required. six steps process, one requires maintainer’s input: new branch created main format YYYY-MM. {renv} configuration file YYYY-MM reset Pull Request created. maintainer follows regular pull request protocol.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/include-child-documents.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Including Child Documents","text":"Writing lesson using Workbench consists writing lesson markdown R Markdown files, placing episodes/ directory defining order files config.yaml file. want author lesson contains content repeated across episodes, {sandpaper} version 0.14, copy paste content across documents, frustrating update line. child documents come . can save repeated snippet markdown inside separate file R Markdown render parent snippet embedded whole time. difference child documents regular episodic content documents independent episodes right. need title, need listed config.yaml, need callout blocks. exist used markdown documents. , recommended make documents overly complex.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/include-child-documents.html","id":"an-example-one-child-document","dir":"Articles","previous_headings":"","what":"An Example: One Child Document","title":"Including Child Documents","text":"can define using child attribute code chunks R Markdown files (note: requires R Markdown). can use many child documents wish, create child files, sure following two rules apply: child documents live files/ folder parent folders reference child files relative parent file. example, file structure like : last lines episodes/introduction.Rmd looks like : can see declaration child document empty code chunk: tells {knitr} take detour render contents files/child.Rmd(relative current working directory, episodes folder). entire document episodes/files/child.Rmd looks like : means episodes/introduction.Rmd built, episodes/files/child.Rmd also built, evaulating sessionInfo(). resulting markdown document look like :","code":"# ./episodes/ # ├── data # ├── fig # ├── files # │ └── child.Rmd # └── introduction.Rmd Cool, right? ```{r si, child=\"files/child.Rmd\"} ``` ::::::::::::::::::::::::::::::::::::: 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 si, child = \"files/child.Rmd\"} ``` ## Session Information The following is the session information of this R session ```{r sessioninfo} sessionInfo() ``` `$\\alpha = \\dfrac{1}{(1 - \\beta)^2}$` becomes: $\\\\alpha = \\\\dfrac{1}{(1 - \\\\beta)^2}$ Cool, right? ## Session Information The following is the session information of this R session ```r sessionInfo() ``` ```output R version 4.4.2 (2024-10-31) Platform: x86_64-pc-linux-gnu Running under: Ubuntu 22.04.5 LTS Matrix products: default BLAS: /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3 LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.20.so; LAPACK version 3.10.0 locale: [1] LC_CTYPE=C.UTF-8 LC_NUMERIC=C LC_TIME=C.UTF-8 [4] LC_COLLATE=C.UTF-8 LC_MONETARY=C.UTF-8 LC_MESSAGES=C.UTF-8 [7] LC_PAPER=C.UTF-8 LC_NAME=C LC_ADDRESS=C [10] LC_TELEPHONE=C LC_MEASUREMENT=C.UTF-8 LC_IDENTIFICATION=C time zone: UTC tzcode source: system (glibc) attached base packages: [1] stats graphics grDevices utils datasets methods base loaded via a namespace (and not attached): [1] compiler_4.4.2 tools_4.4.2 highr_0.11 knitr_1.48 xfun_0.49 [6] evaluate_1.0.1 ``` ::::::::::::::::::::::::::::::::::::: 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 ::::::::::::::::::::::::::::::::::::::::::::::::"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/include-child-documents.html","id":"workspace-consideration","dir":"Articles","previous_headings":"","what":"Workspace consideration","title":"Including Child Documents","text":"{sandpaper} machinery aims keep working space clean possible still allowing authors write way feels natural. processing, assets (.R files, everything files/, fig/, data/) copied source folders site/built/. allows us build R Markdown files using site/built/ working directory accomplishes two things: default sandpaper folder structure flattened website. files R Markdown document creates deletes affect source files project example, let’s say added chunk source R Markdown folder create file data/ directory called “time.txt” reads contents file. lesson gets built, episodes/ directory continue like : Notice file called data/time.txt. file built inside site/built directory. contents directory contains output along files lesson: can see data/, now contains time.txt. rendered Markdown file site/built/introduction.md reflects updates:","code":"--- title: 'introduction' teaching: 10 exercises: 2 --- ```{r setup, echo=FALSE} writeLines(format(Sys.time()), 'data/time.txt') cat(paste0('The time is: ', readLines('data/time.txt'))) ``` # ./episodes/ # ├── data # ├── fig # ├── files # │ └── child.Rmd # └── introduction.Rmd # ./site/built/ # ├── CODE_OF_CONDUCT.md # ├── LICENSE.md # ├── config.yaml # ├── data # │ └── time.txt # ├── fig # │ └── introduction-rendered-pyramid-1.png # ├── files # │ └── child.Rmd # ├── index.md # ├── instructor-notes.md # ├── introduction.md # ├── learner-profiles.md # ├── links.md # ├── md5sum.txt # ├── reference.md # └── setup.md --- title: 'introduction' teaching: 10 exercises: 2 --- ```output The time is: 2024-11-07 18:56:06 ```"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/include-child-documents.html","id":"child-document-assets","dir":"Articles","previous_headings":"","what":"Child document assets","title":"Including Child Documents","text":"use child file, best avoid relying assets external child document . decide reference assets, child documents need assets written already embedded build parent. case, say build parent, refering final parent child document output eventually end . Let’s say wanted refererence figure episodes/fig/one.png link document learners learners/info.md child document, instead ’s located episodes/files/children/child.Rmd, built episodes/introduction.Rmd. parent document (episodes/introduction.Rmd) referencing child document look like : episodes/files/children/child.Rmd, internal link rules, reference resources fig/one.png ../learners/info.md, context build parent directory (case, episodes/), demonstrated : , reason document gets built, result context parent document site/built directory1: makes sense site/built/introduction.md:","code":"# ./episodes/ # ├── data # ├── fig # │ └── one.png # ├── files # │ └── children # │ └── child.Rmd # └── introduction.Rmd Cool, right? ```{r si, child=\"files/children/child.Rmd\"} ``` ::::::::::::::::::::::::::::::::::::: 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 :::::::::::::::::::::::::::::::::::::::::::::::: Here is a link to [the info document](../learners/info.md) {alt='example figure'} ## Session Information The following is the session information of this R session ```{r sessioninfo} sessionInfo() ``` # ./site/built/ # ├── CODE_OF_CONDUCT.md # ├── LICENSE.md # ├── config.yaml # ├── data # │ └── time.txt # ├── fig # │ ├── introduction-rendered-pyramid-1.png # │ └── one.png # ├── files # │ └── children # │ └── child.Rmd # ├── index.md # ├── info.md # ├── instructor-notes.md # ├── introduction.md # ├── learner-profiles.md # ├── links.md # ├── md5sum.txt # ├── reference.md # └── setup.md Cool, right? Here is a link to [the info document](../learners/info.md) {alt='example figure'} ## Session Information The following is the session information of this R session ```r sessionInfo() ``` ```output R version 4.4.2 (2024-10-31) Platform: x86_64-pc-linux-gnu Running under: Ubuntu 22.04.5 LTS Matrix products: default BLAS: /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3 LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.20.so; LAPACK version 3.10.0 locale: [1] LC_CTYPE=C.UTF-8 LC_NUMERIC=C LC_TIME=C.UTF-8 [4] LC_COLLATE=C.UTF-8 LC_MONETARY=C.UTF-8 LC_MESSAGES=C.UTF-8 [7] LC_PAPER=C.UTF-8 LC_NAME=C LC_ADDRESS=C [10] LC_TELEPHONE=C LC_MEASUREMENT=C.UTF-8 LC_IDENTIFICATION=C time zone: UTC tzcode source: system (glibc) attached base packages: [1] stats graphics grDevices utils datasets methods base loaded via a namespace (and not attached): [1] compiler_4.4.2 tools_4.4.2 highr_0.11 knitr_1.48 xfun_0.49 [6] evaluate_1.0.1 ``` ::::::::::::::::::::::::::::::::::::: 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 ::::::::::::::::::::::::::::::::::::::::::::::::"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/include-child-documents.html","id":"what-happens-if-we-use-relative-links-here","dir":"Articles","previous_headings":"Child document assets","what":"What happens if we use relative links here?","title":"Including Child Documents","text":"use relative links child document, find warnings missing files validation:","code":"#> ── Validating Fenced Divs ────────────────────────────────────────────── #> ── Validating Internal Links and Images ──────────────────────────────── #> ! There were errors in 2/39 links and images #> ◌ Some linked internal files do not exist <https://carpentries.github.io/sandpaper/articles/include-child-documents.html#workspace-consideration> #> #> ::warning file=episodes/files/children/child.Rmd,line=1:: [missing file (relative to episodes/)]: [the info document](../../../learners/info.md) #> ::warning file=episodes/files/children/child.Rmd,line=3:: [missing file (relative to episodes/)]: [example](../../fig/one.png)"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/include-child-documents.html","id":"child-documents-of-child-documents","dir":"Articles","previous_headings":"","what":"Child documents of child documents","title":"Including Child Documents","text":"also possible reference child documents within child document, , child documents paths must relative build parent path Thus, child document calling second child document, must write relative path build parent. means want reference episodes/files/child-two.md episodes/files/child-one.Rmd, must write way: episodes/files/child-one.Rmd:","code":"```{r child='files/child-two.md'} ```"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/internationalisation.html","id":"structural-elements-l10n","dir":"Articles","previous_headings":"","what":"Structural Elements (l10n)","title":"Internationalisation (i18n) and Localisation (l10n)","text":"first issue common websites several available solutions exits several languages. moment, Carpentries website supports l10n low-rent manner including yaml dictionary _data directory switching languages via site.data.language variable (shown example translates “content open source”). Though, exactly accessible via main site clear. make sure translations compatible matter tooling use (R, Python, JavaScript, PhP), store translations *.po (portable object) language can use gettext() utility swap translations. associated lesson template , *po files live {varnish} package used R translate messages website generated.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/internationalisation.html","id":"references-and-definitions","dir":"Articles","previous_headings":"","what":"References and Definitions","title":"Internationalisation (i18n) and Localisation (l10n)","text":"References definitions achieved via {glosario} project glossary formatted yaml file python, R libraries can used extract specific translations glossaries.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/internationalisation.html","id":"page-content-i18n","dir":"Articles","previous_headings":"","what":"Page Content (i18n)","title":"Internationalisation (i18n) and Localisation (l10n)","text":"topic currently well addressed quite hard translating prose much harder translating individual messages context individual paragraph section important. David Pérez-Suárez proposed use {gettext} solution standard translating messages several computer programs. found python + BASH project called po4gitbook convert markdown content po files translation back . However, ’s finding breaks lot parsing markdown elements like lists R chunks. ’m thinking solution use parse markdown commonmark XML spec use extract paragraph elements, recast markdown use basis translated messages. way, parsing won’t issue. big challenge library re-written happen.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Landscape View of New Lesson Template","text":"new lesson infrastructure lot moving parts, built solid foundation clearly separates content tooling needed. Importantly, order use infrastructure, need know much works hood. Importantly: beginner’s guide. looking resource, head sandpaper documentation site. document serves kind “nerd’s guide” lesson infrastructure. steps back takes landscape-level view infrastructure works differs previous infrastructure.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"motivation","dir":"Articles","previous_headings":"Introduction","what":"Motivation","title":"Landscape View of New Lesson Template","text":"lesson maintainers contributors volunteers, means limited amount time work lessons. lesson infrastructure simple framework contributors maintainers write lessons way maximizes attention lesson content.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"difficulties-with-the-previous-infrastructure","dir":"Articles","previous_headings":"Introduction","what":"Difficulties with the previous infrastructure","title":"Landscape View of New Lesson Template","text":"Jekyll-based lesson template showing age recently ’s clear refresh sorely needed. Chief among issues Jekyll template currently requires 4 languages (top Git) minimum installed order preview locally: Ruby, Python, Bash, Make. setup represents large barrier people coming lesson maintenance first time clearly issue include videos people use github-based workaround preview lessons. Beyond initial setup contributors, another pain point reliance styles inside lesson convoluted manner lesson must created: must imported carpentries/styles repository history preserved maintainer can initialize lesson. time comes update lesson, expect maintainer touched styling elements machinery merge happens conflicts, rarely case initiate merge fix conflicts. inspect process adding updating content lesson, find still places frustration. configuration file contains several pieces information necessary site, must never touched. Moreover, header yaml lesson contains three lists, objectives, keypoints, questions, formatted strings included body rendered lesson. issue ’s easy become invalid due misplaced punctuation. Linking images lived top repository difficult authoring special block quotes challenging writing content always preceded > proved error prone.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"what-the-new-infrastructure-will-bring","dir":"Articles","previous_headings":"Introduction","what":"What the new infrastructure will bring","title":"Landscape View of New Lesson Template","text":"new lesson infrastructure, strive clear template clutter allow contributors focus important: lesson content written clear easy--read markdown. Importantly, lessons still portable customisable engine, validator, styling live separate independent software packages. Lessons official Carpentries GitHub accounts also benefit automation provide timely updates elements needed build lessons (case lessons generated output). document outline aspects new lesson template describe organized aspects including folder structure lesson, content specifications episode, content specifications extra-episode files (e.g. references), toolchain landscape, local build requirements, deployment specifications, internationalization (i18n) specifications.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"notation","dir":"Articles","previous_headings":"","what":"Notation","title":"Landscape View of New Lesson Template","text":"document intended extensive targeted lesson maintainers infrastructure team. overly-detailed descriptions infrastructure maintainers required know, label points [] maintainers can skip sections needed.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"foundation-structure-of-the-lesson-template","dir":"Articles","previous_headings":"","what":"Foundation: Structure of the Lesson Template","title":"Landscape View of New Lesson Template","text":"section discuss structure template terms file organization go aspects specific tools. new lesson template designed mimic aspects previous template. template designed primarily use Carpentries, theoretically extensible contexts. importantly, contributors expected know markdown minimal yaml syntax. order contribute lessons. Thus, rules new template follow: main branch source truth protected Accessibility priority lesson based WCAG 2.1 guidelines style lessons live template committed content content directly maintainer/contributor configuration files Episodes depend lesson template rendered generated lesson web page exist stand-alone directory can shared offline","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"accessibility","dir":"Articles","previous_headings":"","what":"Accessibility","title":"Landscape View of New Lesson Template","text":"exceptions, lessons shown largely accessible thanks reliance modern frameworks hosting lessons. said, occasional issues WCAG 2.1 accessibility guidelines provides roadmap ensure lessons Perceivable, Operable, Understandable, Robust.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"lesson-folder-organization","dir":"Articles","previous_headings":"","what":"Lesson Folder Organization","title":"Landscape View of New Lesson Template","text":"lesson template organized clearly separates lesson content lesson style:","code":"|-- .gitignore # - Ignore everything in the site/ folder |-- .github/ # - Scripts used for continuous integration |-- episodes/ # - PUT YOUR MARKDOWN FILES IN THIS FOLDER | |-- data/ # -- Data for your lesson goes here | |-- figures/ # -- All static figures and diagrams are here | |-- files/ # -- Additional files (e.g. handouts) | `-- 00-introducition.Rmd # -- Lessons start with a two-digit number |-- instructors/ # - Information for Instructors | `-- instructor-notes.md # -- placeholder |-- learners/ # - Information for Learners | `-- setup.md # -- setup instructions (REQUIRED) |-- profiles/ # - Learner and/or Instructor Profiles | `-- learner-profiles.md # -- placeholder |-- renv/ # - Local package cache |-- site/ # - This folder is where the rendered markdown | | files and static site will live | `-- README.md # -- placeholder |-- config.yaml # - Use this to configure commonly used variables |-- index.md # - Front page for the site |-- CONTRIBUTING.md # - Carpentries Rules for Contributions (REQUIRED) |-- CODE_OF_CONDUCT.md # - Carpentries Code of Conduct (REQUIRED) |-- LICENSE.md # - Carpentries Licenses (REQUIRED) `-- README.md # - Introduces folks how to use this lesson and # where they can find more information."},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"episodes","dir":"Articles","previous_headings":"Lesson Folder Organization","what":"Episodes","title":"Landscape View of New Lesson Template","text":"episodes content required episodes go episodes/ folder (note underscore prefix) extract episodes folder give someone else, able execute RMarkdown documents project using method see fit.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"configuration","dir":"Articles","previous_headings":"Lesson Folder Organization","what":"Configuration","title":"Landscape View of New Lesson Template","text":"file config.yaml minimal yaml file contains metadata lesson-wide aspects (Author, Carpentry, Licence, Title, etc.) along specifications episodes extras included dropdown menus.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"generated-files","dir":"Articles","previous_headings":"Lesson Folder Organization","what":"Generated Files","title":"Landscape View of New Lesson Template","text":"two sources generated files template explicitly tracked git, live site/ directory: static markdown cache generated source files local preview HTML files, generated static markdown files. Separating content generation episode assembly HTML site gives us couple advantages: can cache episodes content generation HTML styling tools needed generate static markdown documents need tools needed apply HTML template (e.g. potentially feasible workflow renders Jupyter Notebook -> Markdown instead RMarkdown -> Markdown). error occurs, assess process source error require sifting HTML diffs. two step process explained Two-Step: Building Locally.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"i-static-markdown-cache","dir":"Articles","previous_headings":"Lesson Folder Organization > Generated Files","what":"[i] Static Markdown Cache","title":"Landscape View of New Lesson Template","text":"static markdown cache files live site/built contain static markdown documents generated output special item yaml header called sandpaper-digest. value item md5 sum corresponding source file tool chain can determine files need rebuilt.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"local-preview-html","dir":"Articles","previous_headings":"Lesson Folder Organization > Generated Files","what":"Local Preview HTML","title":"Landscape View of New Lesson Template","text":"local preview generated website live site/docs folder. site generated static markdown cache site/built source. site/docs folder can shared anywhere fully-functional static website. Many javascript CSS elements sourced CDNs, can also bundled directly site (increases size storage).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"portable-html-lesson","dir":"Articles","previous_headings":"Lesson Folder Organization > Generated Files","what":"Portable HTML Lesson","title":"Landscape View of New Lesson Template","text":"thing preventing lessons used offline fact rely CSS/JS framework delivered CDN, may feasible workshops taught regions internet connectivity limited (though browser cache takes care part). accomodate , procedure creates standalone folder lesson writes outside repository can copied flash drive delivered via local WiFi router.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"episode-structure","dir":"Articles","previous_headings":"","what":"Episode Structure","title":"Landscape View of New Lesson Template","text":"episodes Carpentries stand-alone markdown documents can render valid HTML via pandoc without external dependencies. structure episode largely free-form, certain elements included ensure valid episode form yaml content, required information blocks, instructor notes, properly closed fenced div tags. refresher, fenced div tag line starts least three colons followed name tag. tag closed adding another line starts least three colons tag end: convention, use much 3 : characters clearly indicate block created.","code":"::::::::::::::::::::::::::: challenge This is a *challenge block* ::::::::::::::::::::::::::::::::::::::"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"yaml-metadata","dir":"Articles","previous_headings":"Episode Structure","what":"YAML metadata","title":"Landscape View of New Lesson Template","text":"YAML metadata contain three elements, title, teaching, exercises. title character string title. Markdown can used title. teaching exercises number cumulative minutes required teach lesson complete exercises, respectively. used populate syllabus beginning lesson","code":"title: \"Creating Examples: Yes, These *Are* Difficult\" teaching: 20 exercises: 10"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"required-information-blocks","dir":"Articles","previous_headings":"Episode Structure","what":"Required Information Blocks","title":"Landscape View of New Lesson Template","text":"Objectives (top) - One three statements describes broad concepts learners get lesson Questions (top) - One three questions learners ask start lesson Keypoints (bottom) - point--point reinforcement covered lesson reduce amount friction contributors write displayed lesson, placement enforced validation procedure validated checking proximity blocks elements document XML representation. blocks comply, human-readable alert generated indicating block moved (example error):","code":"Error: File: '/path/to/episode.Rmd' The Questions block should be at the top of the document (lines AA--BB). Instead, they are located at lines XX--YY. Please edit '/path/to/episode.Rmd' and move the block at lines XX--YY to the top of the document (lines AA--BB)."},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"instructor-notes","dir":"Articles","previous_headings":"Episode Structure","what":"Instructor Notes","title":"Landscape View of New Lesson Template","text":"Carpentries lessons traditionally kept instructor notes separate page lessons, lead notes used confusion use . proposed keep instructor notes inside lessons risk creating longer even complicated structure maintainers keep track . acommodate , propose new class tag called instructor, hidden default toggle can display notes alongside lesson. instructor tag tags, starting least three colons ending least three colons: Practically, instructor notes lesson, rendered separate pages placed file called instructor/ can accessed via /path//lesson/instructor/page.html","code":":::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: instructor ## SLOW DOWN :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"fenced-div-tags","dir":"Articles","previous_headings":"Episode Structure","what":"Fenced Div Tags","title":"Landscape View of New Lesson Template","text":"open tags must balanced closing tag. specification fenced divs fairly loose, clarity’s sake, rules thumb. tags necessarily color-coded, ’s good idea differentiate tags length. need specific length, ’s good idea make sure different level tags clearly visible. Instructor tags largest. Aim fences span across document (~80 characters). Top-level tags span least half document (~50 characters). Nested tags (e.g. solution) span quarter document (~25 characters).","code":"# Lesson 1 This is an example lesson. :::::::::::::::::::::::::::::::::::::: objectives - Write good ::::::::::::::::::::::::::::::::::::::::::::::::: :::::::::::::::::::::::::::::::::::: questions - Is it okay if the number of colons don't match up? - Are the sections visible? :::::::::::::::::::::::::::::::::::::::::::::::: ## Introduction Writing tags looks like a bunch of `:` elements. :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: instructor ### Example This is an example of how you write an instructor tag ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: Let's try a challenge. :::::::::::::::::::::::::::::::::::::: challenge Write a solution ::::::::::::::: solution NaCl + H2O :::::::::::::::::::::::: ::::::::::::::::::::::::::::::::::::::::::::::::"},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"links","dir":"Articles","previous_headings":"Episode Structure","what":"Links","title":"Landscape View of New Lesson Template","text":"Carpentries Lessons, contributors need ways specifying links can access part lesson online offline. also need make sure links preserve integrity incoming links people linked lessons past want discover links suffering rot. ultimate goal make sure lesson contributors authors think much beyond see order create link. simplest way authors use relative links html tag end: Link episodes: use [link text](episode-name.html) Link figure episode: use  Link references extras folder: [link text](../extras/references.html)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"code-blocks","dir":"Articles","previous_headings":"Episode Structure","what":"Code Blocks","title":"Landscape View of New Lesson Template","text":"Code Blocks lesson formatted way code blocks formatted commonmark. represented three backtics followed language want use syntax highlighting block.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/landscape.html","id":"evaluation","dir":"Articles","previous_headings":"Episode Structure > Code Blocks","what":"Evaluation","title":"Landscape View of New Lesson Template","text":"encouraging use RMarkdown, can code blocks actually evaluate code using RMarkdown chunk syntax three backtics followed pair curly braces name language engine want use executing code blocks. moment, explicitly support evaluation R BASH, gathering input maintainers processes expand. One promising project Quarto, extends functionality R Markdown languages cross-platform, stand-alone binary program. large list language engines RMarkdown supports. engines require language available PATH share variables values chunks, lesson authors need explicit installation requirements lessons. languages like Python, Julia, SQL can share data variables chunks help specific packages (e.g. {reticulate} Python, {JuliaCall} Julia, {DBI} SQL databases).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"basic-infrastructure-for-maintainers","dir":"Articles","previous_headings":"","what":"Basic Infrastructure for Maintainers","title":"The nerd's guide to the lesson toolchain","text":"manage render lessons, need following software installed. dependencies R packages automatically install. {sandpaper} {varnish} RStudio (>= 1.4) pandoc (>= 2.11) Modern Web Browser Git (>= 2.0) {renv}","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"the-source-of-truth-dependency-management","dir":"Articles","previous_headings":"","what":"The Source of Truth: Dependency Management","title":"The nerd's guide to the lesson toolchain","text":"Python R package ecosystem constantly evolving, can often create different outputs one maintainer’s computer . Moreover, maintain lesson, may want update package using thesis work. alleviate problems, use {renv} R package managing dependencies lessons. managing dependencies, {renv} serves two roles: Package discovery {renv} scan packages declared lesson install computer Package management Lessons use {renv} maintains custom lockfile contains packages required build lesson specific versions, ensuring lesson can reliably reproduced across computers. point, {renv} required building lesson even generated content. can find use {renv} build process reading Building Lessons Package Cache vignette.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"for-markdown-only-lessons","dir":"Articles","previous_headings":"The Source of Truth: Dependency Management","what":"For Markdown-Only Lessons","title":"The nerd's guide to the lesson toolchain","text":"markdown-lesson evaluated code (, copy paste output learners see), need worry dependency management beyond basic infrastructure (taken care automatically).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"for-rmarkdown-lessons-r-bash-python-sql","dir":"Articles","previous_headings":"The Source of Truth: Dependency Management","what":"For RMarkdown Lessons (R, BASH, Python, SQL)","title":"The nerd's guide to the lesson toolchain","text":"lesson uses RMarkdown evaluate code produce output, utmost importance dependencies managed properly lesson. Like Jekyll-based lesson template, take care making sure dependencies okay, difference now ask approve everyone experience. {renv} package relatively stripped-interface, wanted provide opinionated solution management. example, learners advised install anaconda, also encourage recommend. {renv} package aware R Python dependencies, can install add packages lesson usual run single command sandpaper::deps() check update dependencies. Python dependencies live environment.yml file root lesson. moment, bit lives shaky foundation","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"carpentries-specific-packages","dir":"Articles","previous_headings":"","what":"Carpentries-Specific Packages","title":"The nerd's guide to the lesson toolchain","text":"created three R packages designed work explicitly lessons. automatically installed special configuration file inside lesson repository.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"lesson-template-sandpaper","dir":"Articles","previous_headings":"Carpentries-Specific Packages","what":"Lesson Template ({sandpaper})","title":"The nerd's guide to the lesson toolchain","text":"{sandpaper} package creates curates lesson template. package maintainers lesson template need interface . majority maintainers need one function: build_lesson(), evaluate new content render HTML page local machine.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"i-key-packages","dir":"Articles","previous_headings":"Carpentries-Specific Packages > Lesson Template ({sandpaper})","what":"[i] Key Packages","title":"The nerd's guide to the lesson toolchain","text":"{sandpaper} package relies heavily packages internally make sure reinvent wheel much gain benefits tests: {pkgdown} provides scaffolding us able wrap HTML (translated markdown) metadata framework can live separately lesson template. {knitr} engine use translate RMarkdown Markdown without styling output document. {rmarkdown} provides functions give us access pandoc. moment, function use RMarkdown pandoc_convert() transform markdown HTML. {usethis} provides user interface functions creating projects working github. {gert} gives users access git R without need installed.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"i-html-template-varnish","dir":"Articles","previous_headings":"Carpentries-Specific Packages","what":"[i] HTML Template ({varnish})","title":"The nerd's guide to the lesson toolchain","text":"{varnish} package contains template HTML written {{mustache}} templating language. used {sandpaper}, explicitly imported updating can done inside R.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"framework","dir":"Articles","previous_headings":"Carpentries-Specific Packages > [i] HTML Template ({varnish})","what":"Framework","title":"The nerd's guide to the lesson toolchain","text":"NOTE: section needs work information. framework inside {varnish} needs extensible , importantly, separate logic needed create source documents. moment, using bootstrap version 3, version officially deprecated last two years.. moment, two frameworks widely used within R community, bootstrap, distill. benefits distill ’s really nice including citation metadata, one downsides absolutely requires JavaScript enabled (can security risk).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/toolchain.html","id":"i-lesson-validation-and-transformation-pegboard","dir":"Articles","previous_headings":"Carpentries-Specific Packages","what":"[i] Lesson Validation and Transformation ({pegboard})","title":"The nerd's guide to the lesson toolchain","text":"{pegboard} package uses {tinkr} package read markdown XML validate structure schema validate internal structure lessons.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Translating The Workbench","text":"philosophy Carpentries Workbench one separation lesson content tooling needed transform content website. possible write lesson human language syllabary can represented computer. catch : default language website template—navigational elements website—English, authors need tell Workbench language website template use. write lesson specific language, lesson author add lang: 'xx' config.yaml file xx represents language code matches language lesson content. defaults \"en\", can language code (e.g. “ja” specifying Japanese) combination language code country code (e.g. “pt_BR” specifies Pourtugese used Brazil). information used, see Locale Names section gettext manual. country-specific variation language needs added, necessary re-translate everything identical original language file—need translate different. Setting lang: keyword allow lesson navigational elements website template presented language lesson content language added {sandpaper}. , menu items appear English. vignette interest wish update translations add new translations. vignette provide resources updating adding new languages, process translation happens, outline special syntax used {sandpaper}.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"recommended-tools","dir":"Articles","previous_headings":"Resources","what":"Recommended Tools","title":"Translating The Workbench","text":"provide translations non-maintainer, need text editor add translations strings present .po translation files (see files Translating {sandpaper} section. like compile test translations locally, need {potools} package, requires GNU gettext system. mentioned {potools} installation documentation, macOS, likely need use brew install gettext brew install gettext, otherwise, bundled RTools (needed package development Windows) present Linux distributions.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"documentation","dir":"Articles","previous_headings":"Resources","what":"Documentation","title":"Translating The Workbench","text":"documentation {potools} package wonderful resource. Use vignette(\"translators\", package = \"potools\") read details consider translating text package. Another really good resource blog post Maëlle Salmon gives minimum working example translating package messages using {potools}. interested translating lesson content, please consult Joel Nitta’s Carpentries translation guide. can use tools Joel Nitta’s {dovetail} providing method translators track deploy translations Carpentries lessons. can also use rOpenSci’s {babeldown}, uses DeepL API automated translation translators can edit afterwards.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"translating-in-sandpaper","dir":"Articles","previous_headings":"","what":"Translating in {sandpaper}","title":"Translating The Workbench","text":"translations {sandpaper} mostly shuffled {varnish}, template variables written mustache templating. variables define visible menu text “Key Points” screen-reader accessible text buttons “close menu”. 6 languages known {sandpaper}: en de es fr ja uk language known {sandpaper} lesson attempts use language, default back English (source language).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"the-source-files-of-translations","dir":"Articles","previous_headings":"Translating in {sandpaper}","what":"The source files of translations","title":"Translating The Workbench","text":"translate {sandpaper}, working .po files, text files live po/ folder source package. one .po file per language translated. syntax looks like , first line shows file translation exists, second line gives message English, third line gives translation: files recognised several well-established graphical user interfaces, since text files, can edit text editor GitHub directly.","code":"#: build_404.R:57 msgid \"Page not found\" msgstr \"ページが見つかりません\""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"how-translations-are-processed-in-r","dir":"Articles","previous_headings":"Translating in {sandpaper}","what":"How translations are processed in R","title":"Translating The Workbench","text":"po files compiled binary .mo files carried built package user’s computer. files used R function base::gettext() translate messages specific context. context {sandpaper} known R-sandpaper. language exist, revert English: make translation keys easier detect, internal convenience function, tr_() defined, addition, source strings keys translations can found tr_src(), tr_varnish() tr_computed(), want find context given translation key, can find searching source code tr_.","code":"library(\"withr\") library(\"sandpaper\") known_languages() #> [1] \"en\" \"de\" \"es\" \"fr\" \"ja\" \"uk\" with_language(\"ja\", { enc2utf8(gettext(\"Page not found\", domain = \"R-sandpaper\")) }) #> [1] \"ページが見つかりません\" with_language(\"en\", { enc2utf8(gettext(\"Page not found\", domain = \"R-sandpaper\")) }) #> [1] \"Page not found\" with_language(\"xx\", { enc2utf8(gettext(\"Page not found\", domain = \"R-sandpaper\")) }) #> [1] \"Page not found\""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"special-syntax-for-translators","dir":"Articles","previous_headings":"Translating in {sandpaper}","what":"Special syntax for translators","title":"Translating The Workbench","text":"content translation requires variables markup added translation. Items {curly_braces} variables remain English: Words <(kirby quotes)> HTML markup surrounding translated:","code":"#: utils-translate.R:52 msgid \"Estimated time: {icons$clock} {minutes} minutes\" msgstr \"所要時間：{icons$clock} {minutes}分\" #: utils-translate.R:62 msgid \"This lesson is subject to the <(Code of Conduct)>\" msgstr \"このレッスンは<(行動規範)>の対象となります\""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"updates-to-translations","dir":"Articles","previous_headings":"Translating in {sandpaper}","what":"Updates to translations","title":"Translating The Workbench","text":"may times future translations need updated text changes added. happens, maintainer {sandpaper} run following commands extract new translation strings, update languages, recompile .mo files built package. languages updated, translation utility attempt make fuzzy matches create new strings. example, update “Page found” translation title case, add punctuation little whimsy \"Page? Found! -_-;\", go edit translation, might see something like : old translation used translator updates runs potools::po_compile() update .mo files. new strings translations added, translation utility assume know anything translation appear like : translation available given string, default string :","code":"potools::po_extract() potools::po_update() potools::po_compile() #: build_404.R:57 #, fuzzy #| msgid \"Page not found\" msgid \"Page? Not Found! -_-;\" msgstr \"ページが見つかりません\" #: build_404.R:57 msgid \"A new translation approaches!\" msgstr \"\" with_language(\"ja\", { enc2utf8(gettext(\"A new translation approaches!\", domain = \"R-sandpaper\")) }) #> [1] \"A new translation approaches!\""},{"path":"https://carpentries.github.io/sandpaper/dev/articles/translations.html","id":"list-of-translation-variables","dir":"Articles","previous_headings":"","what":"List of Translation Variables","title":"Translating The Workbench","text":"62 translations generated set_language() correspond following variables varnish: addition, 27 translations inserted get varnish:","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Robert Davey. Author, maintainer. Erin Becker. Author. Zhian N. Kamvar. Author. Julien Colomb. Contributor. Ben Companjen. Contributor. Toby Hodges. Contributor. François Michonneau. Contributor. Kelly Barnes. Contributor. Hugo Gruson. Contributor. Milan Malfait. Contributor. Joel H. Nitta. Author, translator. Yanina Bellini Saibene. Contributor, translator. Martin Raden. Contributor, translator.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Davey R, Becker E, Kamvar Z, Nitta J (2024). sandpaper: Create Curate Carpentries Lessons. R package version 0.16.10.9000, https://github.com/carpentries/sandpaper/, https://carpentries.github.io/workbench/, https://carpentries.github.io/sandpaper/.","code":"@Manual{, title = {sandpaper: Create and Curate Carpentries Lessons}, author = {Robert Davey and Erin Becker and Zhian N. Kamvar and Joel H. Nitta}, year = {2024}, note = {R package version 0.16.10.9000, https://github.com/carpentries/sandpaper/, https://carpentries.github.io/workbench/}, url = {https://carpentries.github.io/sandpaper/}, }"},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"sandpaper-user-interface-to-the-carpentries-workbench-","dir":"","previous_headings":"","what":"The Carpentries Lesson Infrastructure Engine","title":"The Carpentries Lesson Infrastructure Engine","text":"{sandpaper} package created Carpentries re-imagine method creating lesson websites workshops. package take series Markdown RMarkdown files generate static website features styling Carpentries lessons including customized layouts callout blocks. Much functionality package inspired Jenny Bryan’s work {usethis} package.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"documentation","dir":"","previous_headings":"","what":"Documentation","title":"The Carpentries Lesson Infrastructure Engine","text":"Want know works lesson format? Head https://carpentries.github.io/sandpaper-docs/. , instead, already know lesson built interested understanding functions {sandpaper} work, can visit package documentation site https://carpentries.github.io/sandpaper/.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"The Carpentries Lesson Infrastructure Engine","text":"{sandpaper} currently CRAN, can installed Carpentries Universe (updated every hour) following commands: Note also install development versions following packages:","code":"options(repos = c( carpentries = \"https://carpentries.r-universe.dev/\", CRAN = \"https://cran.rstudio.com/\" )) install.packages(\"sandpaper\", dep = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"design","dir":"","previous_headings":"","what":"Design","title":"The Carpentries Lesson Infrastructure Engine","text":"package designed make life lesson contributors maintainers easier separating tools needed build site user-defined content site . longer rely Jekyll >450 static site generators, instead rely R, RStudio, {pkgdown} generate site following features: optional offline use filename-agnostic episode arrangements clear definitions package versions needed build lesson lesson versioning (e.g. can navigate https://swcarpentry.github.io/python-novice-gapminder current version https://swcarpentry.github.io/python-novice-gapminder/2020-11 release 2020-11) seamless updates Carpentries’ style caching rendered content rapid deployment packaging {learnr} materials validation lesson structure git aware, require contributors git installed","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"rendering-locally","dir":"","previous_headings":"Design","what":"Rendering locally","title":"The Carpentries Lesson Infrastructure Engine","text":"local two-step model deployment local folders repository generated via {sandpaper}, source committed avoid issues surrounding --date artefacts directory structure confusion. website generated two steps: markdown files source files rendered containing hash source file need re-rendered change. html files generated rendered markdown files CSS JS sources {varnish} package preview. ensure clashes minor differences user setup, artifacts committed main branch repository. caching mechanism website rendered markdown files, long-running lessons can updated previewed quickly.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"rendering-on-continuous-integration","dir":"","previous_headings":"Design","what":"Rendering on continuous integration","title":"The Carpentries Lesson Infrastructure Engine","text":"Two-step deployment model continuous integration Continuous integration act single source--truth outputs lessons rendered. , want resulting website : CI agnostic (currently set GitHub) easy set auditable (e.g. can see changes content two commits) versionable (e.g. can instruct learners go <WEBSITE>/1.1. inspired python documentation style) acheive , two branches created: md-outputs gh-pages inerit like main -> md-outputs -> gh-pages. build time main md-outputs can time intensive, default updating files changed. md-outputs: branch contain files artifacts generated rmarkdown vignettes directory thin package skeleton. gh-pages: branch generated via md-outputs bundles html, css, js website. contain single index.html file several subfolders different versions site. index.html file redirect current/ directory, contains --date site.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"scheduled-builds","dir":"","previous_headings":"Design > Rendering on continuous integration","what":"Scheduled builds","title":"The Carpentries Lesson Infrastructure Engine","text":"gh-pages website: designing lessons content separated styling, set CI generate webpage pre-built sources weekly basis, check update styles ({varnish} package) rebuild site without rebuilding content. md-outputs branch: rerun every month scratch recent version R R packages. change, pull request can generated update renv.lock file link changed markdown files branch.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"function-syntax","dir":"","previous_headings":"Design","what":"Function syntax","title":"The Carpentries Lesson Infrastructure Engine","text":"functions {sandpaper} following prefixes: create_ create/amend files folders workspace update_ update build resources lesson build_ build files source check_ validates either elements lesson /episodes fetch_ download files resources internet reset_ removes files information get_ retrieve information source files R object set_ update information files. ci_ interacts continous integration build website working list user-facing functions: Lesson Episode Creation create_lesson() creates lesson scratch create_episode() creates new episode correct number prefix create_dataset() creates csv text data set R object set_episodes() arranges episodes user-specified order Accessors get_config() reads contents config.yaml list get_drafts() reports files listed config.yaml get_episodes() returns episode filenames vector get_syllabus() returns syllabus timings, titles, questions Website Creation Validation check_lesson() checks validates source files lesson structure build_episode_md() renders individual file markdown (internal use) build_episode_html() renders built markdown file html (internal use) build_lesson() builds lesson static website build_portable_lesson() builds lesson portable static website fetch_lesson() fetches static website lesson repository Continuous Integration Utilities ci_deploy() builds deploys lesson CI source files ci_build_markdown() builds markdown files CI source deploys markdown branch. ci_build_site() deploys lesson CI pre-rendered markdown files ci_release() builds deploys lesson CI source files adds release tag update_github_workflows() updates GitHub workflows Cleanup reset_episodes() removes schedule config.yaml file reset_site() clears website cache","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"The Carpentries Lesson Infrastructure Engine","text":"five use-cases {sandpaper}: Creating lessons Contributing lessons Maintaining lessons Rendering portable site Rendering site GitHub actions.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"creating-a-lesson","dir":"","previous_headings":"Usage","what":"Creating a lesson","title":"The Carpentries Lesson Infrastructure Engine","text":"create lesson {sandpaper}, use create_lesson() function: create folder desktop called r-intermediate-penguins following structure: site set , can add RMarkdown files episodes folder. default, built alphabetical order, can use set_episodes() command build schedule config.yaml file: want preview site, use following: using RStudio, can preview lesson site using keyboard shortcut ctrl + shift + B (corresponds “Build Website” button “Build” tab. preview individual files, can use ctrl + shift + K (corresponds “Knit” button editor pane) create website structure inside site/ folder, render RMarkdown files markdown (inspection quick rendering), render markdown files HTML, enable preview within browser window.","code":"sandpaper::create_lesson(\"~/Desktop/r-intermediate-penguins\") |-- .gitignore # - Ignore everything in the site/ folder |-- .github/ # - Scripts used for continuous integration | `-- workflows/ # | |-- deploy-site.yaml # - Build the source files on github pages | |-- build-md.yaml # - Build the markdown files on github pages | `-- cron.yaml # - reset package cache and test |-- episodes/ # - PUT YOUR MARKDOWN FILES IN THIS FOLDER | |-- data/ # - Data for your lesson goes here | |-- figures/ # - All static figures and diagrams are here | |-- files/ # - Additional files (e.g. handouts) | `-- 00-introducition.Rmd # - Lessons start with a two-digit number |-- instructors/ # - Information for Instructors |-- learners/ # - Information for Learners | `-- setup.md # - setup instructions (REQUIRED) |-- profiles/ # - Learner and/or Instructor Profiles |-- site/ # - This folder is where the rendered markdown files and static site will live | `-- README.md # - placeholder |-- config.yaml # - Use this to configure commonly used variables |-- CONTRIBUTING.md # - Carpentries Rules for Contributions (REQUIRED) |-- CODE_OF_CONDUCT.md # - Carpentries Code of Conduct (REQUIRED) |-- LICENSE.md # - Carpentries Licenses (REQUIRED) `-- README.md # - Introduces folks how to use this lesson and where they can find more information. s <- sandpaper::get_episodes() sandpaper::set_episodes(order = s, write = TRUE) sandpaper::build_lesson()"},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"contributing-to-a-lesson","dir":"","previous_headings":"Usage","what":"Contributing to a Lesson","title":"The Carpentries Lesson Infrastructure Engine","text":"contribute lesson, can either fork lesson repository clone computer manually GitHub, can use {usethis} package automate . example, can create copy Programming R computer’s Desktop. copy source files computer move directory. Note rendered website immediately available. download site currently appears web, use: download site rendered markdown files site/ folder. save bandwidth, can choose just download markdown files artifacts settin site = FALSE. Now, can edit Rmarkdown files episodes/ quickly render site. upload changes lesson repository, can use follow","code":"usethis::create_from_github( repo = \"swcarpentry/r-novice-gapminder\", destdir = \"~/Desktop/r-novice-gampinder\", fork = TRUE ) sandpaper::fetch_lesson(markdown = TRUE, site = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"maintaining-a-lesson","dir":"","previous_headings":"Usage","what":"Maintaining a Lesson","title":"The Carpentries Lesson Infrastructure Engine","text":"maintaining lesson, high likelihood already copy machine. , follow instructions contributing lesson section . typical workflow look like : open sandpaper project RStudio make edits files episodes/ folder R console run following","code":"sandpaper::check_lesson() # validates the structure of the input files sandpaper::build_lesson() # builds and validates lesson"},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"rendering-a-portable-site","dir":"","previous_headings":"Usage","what":"Rendering a portable site","title":"The Carpentries Lesson Infrastructure Engine","text":"render portable site, can follow instructions contributing lesson maintaining lesson set . lesson set , can use following command: render fully portable lesson site zip file site/ folder. can distribute lesson learners reliable internet access use offline without sacrificing styling.","code":"sandpaper::build_portable_lesson(version = \"current\")"},{"path":"https://carpentries.github.io/sandpaper/dev/index.html","id":"rendering-with-github-actions","dir":"","previous_headings":"Usage","what":"Rendering with GitHub actions","title":"The Carpentries Lesson Infrastructure Engine","text":"Ultimately, minimal number functions handle situation writing CI configuration files maddening. straightforward function : function create git worktrees orphan md-outputs branch site/built folder orphan gh-pages branch site/docs folder. , generate site normal. css js libraries may need updating lesson material , step can created just rebuilding site uses: lesson given release, current site folder needs duplicated versioned folder tag needs added md-outputs branch:","code":"sandpaper::ci_deploy(md_branch = \"md-outputs\", site_branch = \"gh-pages\") sandpaper::ci_build_site(branch = \"gh-pages\") sandpaper::ci_release(tag = \"0.1\", md_branch = \"md-outputs\", site_branch = \"gh-pages\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_404.html","id":null,"dir":"Reference","previous_headings":"","what":"Build the 404 page for a lesson — build_404","title":"Build the 404 page for a lesson — build_404","text":"Build 404 page lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_404.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build the 404 page for a lesson — build_404","text":"","code":"build_404(pkg, quiet = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_404.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build the 404 page for a lesson — build_404","text":"pkg list object generated pkgdown::as_pkgdown() quiet passed build_html(). FALSE (default), message printed screen build progress. TRUE, messages generated.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_404.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build the 404 page for a lesson — build_404","text":"TRUE page successfully generated","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_404.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build the 404 page for a lesson — build_404","text":"lesson build process, 404 page absolute links back source pages must generated otherwise, subsequent attempts escape 404 page futile. function intended run lesson website already built called side-effect creating 404 page.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_agg.html","id":null,"dir":"Reference","previous_headings":"","what":"Build a page for aggregating common elements — build_aio","title":"Build a page for aggregating common elements — build_aio","text":"Build page aggregating common elements","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_agg.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build a page for aggregating common elements — build_aio","text":"","code":"build_aio(pkg, pages = NULL, quiet = FALSE) build_images(pkg, pages = NULL, quiet = FALSE) build_instructor_notes(pkg, pages = NULL, built = NULL, quiet) build_keypoints(pkg, pages = NULL, quiet = FALSE) build_agg_page( pkg, pages, title = NULL, slug = NULL, aggregate = \"section\", append = \"self::node()\", prefix = FALSE, quiet = FALSE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_agg.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build a page for aggregating common elements — build_aio","text":"pkg object created via pkgdown::as_pkgdown() lesson. pages output function read_all_html(): nested list xml_document objects representing episodes lesson quiet TRUE, messages emitted. FALSE, pkgdown report creation temporary file. built vector markdown documents recently rebuilt (future use) title new page title slug slug page (e.g. \"aio\" become \"aio.html\") aggregate selector lesson content want aggregate. default \"section\", aggregate sections, nothing outside sections. grab everything page, use \"*\" append selector section page aggregate data placed. defaults \"self::node()\", indicates entire page appended. prefix flag add prefix aggregated sections. Defaults FALSE.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_agg.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build a page for aggregating common elements — build_aio","text":"NULL, invisibly. called side-effect","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_agg.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build a page for aggregating common elements — build_aio","text":"Building aggregate page much akin copy/paste—take elements across several pages paste one large page. can programmatically using XPath extract nodes pages add document. customise page, need things: title slug method prepare insert extracted content (e.g. make_aio_section())","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_agg.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Build a page for aggregating common elements — build_aio","text":"function assumes already built episodes lesson.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_agg.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build a page for aggregating common elements — build_aio","text":"","code":"if (FALSE) { # build_aio() assumes that your lesson has been built and takes in a # pkgdown object, which can be created from the `site/` folder in your # lesson. lsn <- \"/path/to/my/lesson\" pkg <- pkgdown::as_pkgdown(fs::path(lsn, \"site\")) htmls <- read_all_html(pkg$dst_path) build_aio(pkg, htmls, quiet = FALSE) build_keypoints(pkg, htmls, quiet = FALSE) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_html.html","id":null,"dir":"Reference","previous_headings":"","what":"Build a single episode html file — build_episode_html","title":"Build a single episode html file — build_episode_html","text":"Carpentries-specific wrapper around pkgdown::render_page() templates {varnish}. function largely internal use likely change.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_html.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build a single episode html file — build_episode_html","text":"","code":"build_episode_html( path_md, path_src = NULL, page_back = \"index.md\", page_forward = \"index.md\", pkg, quiet = FALSE, page_progress = NULL, sidebar = NULL, date = NULL )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_html.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build a single episode html file — build_episode_html","text":"path_md path episode markdown (RMarkdown) file (usually via build_episode_md()). path_src default NULL indicating source file determined sandpaper-source entry yaml header. present, option allows specify file. page_back URL previous page page_forward URL next page pkg pkgdown object containing metadata site quiet TRUE, messages produced. Defaults TRUE. page_progress integer 0 100 indicating rounded percent page progress. Defaults NULL. sidebar character vector links episodes use sidebar. current episode replaced index chapters episode. date date episode last built.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_html.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build a single episode html file — build_episode_html","text":"TRUE page successful, FALSE otherwise.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_html.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Build a single episode html file — build_episode_html","text":"function internal use, exported know .","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_html.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build a single episode html file — build_episode_html","text":"","code":"if (FALSE) { # 2022-04-15: this suddenly started throwing a check error # that says \"connections left open: (file) and I can't figure out where the # hell its coming from, so I'm just going to not run this :( if (.Platform$OS.type == \"windows\") { options(\"sandpaper.use_renv\" = FALSE) } if (!interactive() && getOption(\"sandpaper.use_renv\")) { old <- renv::config$cache.symlinks() options(renv.config.cache.symlinks = FALSE) on.exit(options(renv.config.cache.symlinks = old), add = TRUE) } tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = TRUE) suppressMessages(set_episodes(tmp, get_episodes(tmp), write = TRUE)) if (rmarkdown::pandoc_available(\"2.11\")) { # we can only build this if we have pandoc build_lesson(tmp) } # create a new file in files fun_file <- file.path(tmp, \"episodes\", \"files\", \"fun.Rmd\") txt <- c( \"---\\ntitle: Fun times\\n---\\n\\n\", \"# new page\\n\", \"This is coming from `r R.version.string`\\n\", \"::: testimonial\\n\\n#### testimony!\\n\\nwhat\\n:::\\n\" ) file.create(fun_file) on.exit(unlink(tmp, recursive = TRUE, force = TRUE)) writeLines(txt, fun_file) hash <- tools::md5sum(fun_file) res <- build_episode_md(fun_file, hash) if (rmarkdown::pandoc_available(\"2.11\")) { # we need to set the global values sandpaper:::set_globals(res) on.exit(clear_globals(), add = TRUE) # we can only build this if we have pandoc build_episode_html(res, path_src = fun_file, pkg = pkgdown::as_pkgdown(file.path(tmp, \"site\")) ) } }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_md.html","id":null,"dir":"Reference","previous_headings":"","what":"Build an episode to markdown — build_episode_md","title":"Build an episode to markdown — build_episode_md","text":"uses knitr::knit() custom options set Carpentries template. runs separate process avoid issues user-specific options bleeding .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_md.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build an episode to markdown — build_episode_md","text":"","code":"build_episode_md( path, hash = NULL, outdir = path_built(path), workdir = path_built(path), workenv = globalenv(), profile = \"lesson-requirements\", quiet = FALSE, error = TRUE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_md.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build an episode to markdown — build_episode_md","text":"path path RMarkdown file hash hash prepend output. parameter deprecated effectively useless. outdir directory write workdir directory episode rendered workenv environment use evaluation. Defaults global environment, evaluates environment callr::r(). quiet TRUE, output suppressed, default FALSE show {knitr} output. error TRUE (default) errors make invalid build. can set false cause build fail error occurs. generally controlled via fail_on_error config option.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_md.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build an episode to markdown — build_episode_md","text":"path output, invisibly","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_md.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Build an episode to markdown — build_episode_md","text":"function internal use, exported know .","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_episode_md.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build an episode to markdown — build_episode_md","text":"","code":"if (.Platform$OS.type == \"windows\") { options(\"sandpaper.use_renv\" = FALSE) } if (!interactive() && getOption(\"sandpaper.use_renv\")) { old <- renv::config$cache.symlinks() options(renv.config.cache.symlinks = FALSE) on.exit(options(renv.config.cache.symlinks = old), add = TRUE) } fun_dir <- tempfile() dir.create(fs::path(fun_dir, \"episodes\"), recursive = TRUE) fun_file <- file.path(fun_dir, \"episodes\", \"fun.Rmd\") file.create(fun_file) #> [1] TRUE txt <- c( \"---\\ntitle: Fun times\\n---\\n\\n\", \"# new page\\n\", \"This is coming from `r R.version.string`\" ) writeLines(txt, fun_file) res <- build_episode_md(fun_file, outdir = fun_dir, workdir = fun_dir) #> #> #> processing file: /tmp/RtmpQSXDNq/file170624254065/episodes/fun.Rmd #> 1/1 #> output file: /tmp/RtmpQSXDNq/file170624254065/fun.md #> #>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_handout.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a code handout of challenges without solutions — build_handout","title":"Create a code handout of challenges without solutions — build_handout","text":"function build handout save files/code-handout.R lesson website. build website enable options(sandpaper.handout = TRUE) want specify path, can use options(sandpaper.handout = \"/path//handout.R\") save handout specific path.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_handout.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a code handout of challenges without solutions — build_handout","text":"","code":"build_handout(path = \".\", out = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_handout.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a code handout of challenges without solutions — build_handout","text":"path path lesson. Defaults current working directory path handout document. NULL (default) TRUE, output site/built/files/code-handout.R.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_home.html","id":null,"dir":"Reference","previous_headings":"","what":"Build a home page for a lesson — build_home","title":"Build a home page for a lesson — build_home","text":"Build home page lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_home.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build a home page for a lesson — build_home","text":"","code":"build_home(pkg, quiet, next_page = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_home.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build a home page for a lesson — build_home","text":"pkg list generated pkgdown::as_pkgdown() site/ folder lesson. quiet boolean passed build_html(). TRUE, pkgdown report files built next_page next page file name. allow navigation element set correctly navigation bar","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_home.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build a home page for a lesson — build_home","text":"nothing. used side-effect","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_home.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build a home page for a lesson — build_home","text":"index page lesson combination two pages: index.md (README index exist) learners/setup.md function uses render_html() convert page HTML, gets passed \"syllabus\" \"overview\" templates {varnish} (via build_html() function {{{ readme }}} {{{ setup }}} keys.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_html.html","id":null,"dir":"Reference","previous_headings":"","what":"Build instructor and learner HTML page — build_html","title":"Build instructor and learner HTML page — build_html","text":"Build instructor learner HTML page","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_html.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build instructor and learner HTML page — build_html","text":"","code":"build_html( template = \"chapter\", pkg, nodes, global_data, path_md, quiet = TRUE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_html.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build instructor and learner HTML page — build_html","text":"template name {varnish} template use. Defaults \"chapter\" pkg object created pkgdown::as_pkgdown() nodes xml_document object. nodes list two xml_documents; one instructors one learners instructors schedule available . instructor learner page, single xml_document object. global_data list store object contains copies global variables page, including metadata, navigation, variables {varnish} templates. path_md path (absolute, relative, filename) current markdown file processed. quiet parameter passed pkgdown::render_page() print progress TRUE (default).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_html.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build instructor and learner HTML page — build_html","text":"TRUE page built NULL need rebuilt","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_html.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build instructor and learner HTML page — build_html","text":"function central workhorse connects global lesson metadata global variables page rendering engine: {pkgdown}. perform global operations includes setting navigation (via update_sidebar()), adding metadata, building instructor learner versions page (via pkgdown::render_page()). Workbench, three types pages: primary content pages: primary content 1:1 relationship source output. episodes along custom learner instructor content aggregate content pages: pages aggregated pages key points, --one, images concatenated content pages: concatenations source files potentially aggregate data. Examples index, learner profiles, instructor notes pages. types pages process setting content, gets processed passed .","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_lesson.html","id":null,"dir":"Reference","previous_headings":"","what":"Build your lesson site — build_lesson","title":"Build your lesson site — build_lesson","text":"function orchestrates rendering generated lesson content applying theme HTML site.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_lesson.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build your lesson site — build_lesson","text":"","code":"build_lesson( path = \".\", rebuild = FALSE, quiet = !interactive(), preview = TRUE, override = list() )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_lesson.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build your lesson site — build_lesson","text":"path path repository (defaults current working directory) rebuild TRUE, everything built scratch cache. Defaults FALSE, build markdown files built . quiet TRUE, output supressed preview TRUE, rendered website opened new window override options override (e.g. building alternative paths). used internally likely changed.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_lesson.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build your lesson site — build_lesson","text":"TRUE successful, character vector issues unsuccessful.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_lesson.html","id":"structure-of-a-workbench-lesson","dir":"Reference","previous_headings":"","what":"Structure of a Workbench Lesson","title":"Build your lesson site — build_lesson","text":"Carpentries Workbench lesson comprised set markdown files folders:","code":"+-- config.yaml +-- index.md +-- episodes | +-- data | +-- fig | +-- files | \\-- introduction.Rmd +-- instructors | \\-- instructor-notes.md +-- learners | \\-- setup.md +-- profiles | \\-- learner-profiles.md +-- links.md +-- site \\-- [...] +-- renv | \\-- [...] +-- CODE_OF_CONDUCT.md +-- CONTRIBUTING.md +-- LICENSE.md \\-- README.md"},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_lesson.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build your lesson site — build_lesson","text":"","code":"tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file17068ffafbb... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17068ffafbb... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17068ffafbb... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpQSXDNq/file17068ffafbb... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file17068ffafbb... #> ☐ Edit /tmp/RtmpQSXDNq/file17068ffafbb/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17068ffafbb... #> ✔ First episode created in /tmp/RtmpQSXDNq/file17068ffafbb/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpQSXDNq/file17068ffafbb... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpQSXDNq/file17068ffafbb... #> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file17068ffafbb #> → Creating Lesson in /tmp/RtmpQSXDNq/file17068ffafbb... #> /tmp/RtmpQSXDNq/file17068ffafbb create_episode(\"first-script\", path = tmp, open = FALSE) #> ☐ Edit /tmp/RtmpQSXDNq/file17068ffafbb/episodes/first-script.Rmd. #> /tmp/RtmpQSXDNq/file17068ffafbb/episodes/first-script.Rmd check_lesson(tmp) build_lesson(tmp) #> ── Initialising site ─────────────────────────────────────────────────── #> Copying <pkgdown>/BS3/assets/bootstrap-toc.css to bootstrap-toc.css #> Copying <pkgdown>/BS3/assets/bootstrap-toc.js to bootstrap-toc.js #> Copying <pkgdown>/BS3/assets/docsearch.css to docsearch.css #> Copying <pkgdown>/BS3/assets/docsearch.js to docsearch.js #> Copying <pkgdown>/BS3/assets/link.svg to link.svg #> Copying <pkgdown>/BS3/assets/pkgdown.css to pkgdown.css #> Copying <pkgdown>/BS3/assets/pkgdown.js to pkgdown.js #> Copying <varnish>/pkgdown/assets/android-chrome-192x192.png to #> android-chrome-192x192.png #> Copying <varnish>/pkgdown/assets/android-chrome-512x512.png to #> android-chrome-512x512.png #> Copying <varnish>/pkgdown/assets/apple-touch-icon.png to #> apple-touch-icon.png #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.eot to #> assets/fonts/Mulish-Black.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.svg to #> assets/fonts/Mulish-Black.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.ttf to #> assets/fonts/Mulish-Black.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.woff to #> assets/fonts/Mulish-Black.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.woff2 to #> assets/fonts/Mulish-Black.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.eot to #> assets/fonts/Mulish-BlackItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.svg to #> assets/fonts/Mulish-BlackItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.ttf to #> assets/fonts/Mulish-BlackItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.woff #> to assets/fonts/Mulish-BlackItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.woff2 #> to assets/fonts/Mulish-BlackItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.eot to #> assets/fonts/Mulish-Bold.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.svg to #> assets/fonts/Mulish-Bold.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.ttf to #> assets/fonts/Mulish-Bold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.woff to #> assets/fonts/Mulish-Bold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.woff2 to #> assets/fonts/Mulish-Bold.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.eot to #> assets/fonts/Mulish-BoldItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.svg to #> assets/fonts/Mulish-BoldItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.ttf to #> assets/fonts/Mulish-BoldItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.woff to #> assets/fonts/Mulish-BoldItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.woff2 #> to assets/fonts/Mulish-BoldItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.eot to #> assets/fonts/Mulish-ExtraBold.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.svg to #> assets/fonts/Mulish-ExtraBold.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.ttf to #> assets/fonts/Mulish-ExtraBold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.woff to #> assets/fonts/Mulish-ExtraBold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.woff2 to #> assets/fonts/Mulish-ExtraBold.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.eot to #> assets/fonts/Mulish-ExtraBoldItalic.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.svg to #> assets/fonts/Mulish-ExtraBoldItalic.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.ttf to #> assets/fonts/Mulish-ExtraBoldItalic.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.woff to #> assets/fonts/Mulish-ExtraBoldItalic.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.woff2 to #> assets/fonts/Mulish-ExtraBoldItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.eot to #> assets/fonts/Mulish-ExtraLight.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.svg to #> assets/fonts/Mulish-ExtraLight.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.ttf to #> assets/fonts/Mulish-ExtraLight.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.woff to #> assets/fonts/Mulish-ExtraLight.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.woff2 #> to assets/fonts/Mulish-ExtraLight.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.eot to #> assets/fonts/Mulish-ExtraLightItalic.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.svg to #> assets/fonts/Mulish-ExtraLightItalic.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.ttf to #> assets/fonts/Mulish-ExtraLightItalic.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.woff to #> assets/fonts/Mulish-ExtraLightItalic.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.woff2 to #> assets/fonts/Mulish-ExtraLightItalic.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic-VariableFont_wght.ttf #> to assets/fonts/Mulish-Italic-VariableFont_wght.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.eot to #> assets/fonts/Mulish-Italic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.svg to #> assets/fonts/Mulish-Italic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.ttf to #> assets/fonts/Mulish-Italic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.woff to #> assets/fonts/Mulish-Italic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.woff2 to #> assets/fonts/Mulish-Italic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.eot to #> assets/fonts/Mulish-Light.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.svg to #> assets/fonts/Mulish-Light.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.ttf to #> assets/fonts/Mulish-Light.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.woff to #> assets/fonts/Mulish-Light.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.woff2 to #> assets/fonts/Mulish-Light.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.eot to #> assets/fonts/Mulish-LightItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.svg to #> assets/fonts/Mulish-LightItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.ttf to #> assets/fonts/Mulish-LightItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.woff #> to assets/fonts/Mulish-LightItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.woff2 #> to assets/fonts/Mulish-LightItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.eot to #> assets/fonts/Mulish-Medium.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.svg to #> assets/fonts/Mulish-Medium.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.ttf to #> assets/fonts/Mulish-Medium.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.woff to #> assets/fonts/Mulish-Medium.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.woff2 to #> assets/fonts/Mulish-Medium.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.eot #> to assets/fonts/Mulish-MediumItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.svg #> to assets/fonts/Mulish-MediumItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.ttf #> to assets/fonts/Mulish-MediumItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.woff #> to assets/fonts/Mulish-MediumItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.woff2 #> to assets/fonts/Mulish-MediumItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.eot to #> assets/fonts/Mulish-Regular.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.svg to #> assets/fonts/Mulish-Regular.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.ttf to #> assets/fonts/Mulish-Regular.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.woff to #> assets/fonts/Mulish-Regular.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.woff2 to #> assets/fonts/Mulish-Regular.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.eot to #> assets/fonts/Mulish-SemiBold.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.svg to #> assets/fonts/Mulish-SemiBold.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.ttf to #> assets/fonts/Mulish-SemiBold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.woff to #> assets/fonts/Mulish-SemiBold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.woff2 to #> assets/fonts/Mulish-SemiBold.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.eot #> to assets/fonts/Mulish-SemiBoldItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.svg #> to assets/fonts/Mulish-SemiBoldItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.ttf #> to assets/fonts/Mulish-SemiBoldItalic.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.woff to #> assets/fonts/Mulish-SemiBoldItalic.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.woff2 to #> assets/fonts/Mulish-SemiBoldItalic.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-VariableFont_wght.ttf to #> assets/fonts/Mulish-VariableFont_wght.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.eot to #> assets/fonts/MulishExtraLight-Regular.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.svg to #> assets/fonts/MulishExtraLight-Regular.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.woff to #> assets/fonts/MulishExtraLight-Regular.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.woff2 to #> assets/fonts/MulishExtraLight-Regular.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.eot to #> assets/fonts/mulish-v5-latin-regular.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.svg to #> assets/fonts/mulish-v5-latin-regular.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.ttf to #> assets/fonts/mulish-v5-latin-regular.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff to #> assets/fonts/mulish-v5-latin-regular.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff2 to #> assets/fonts/mulish-v5-latin-regular.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff to #> assets/fonts/mulish-variablefont_wght.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff2 to #> assets/fonts/mulish-variablefont_wght.woff2 #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo-sm.svg #> to assets/images/carpentries-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo.svg to #> assets/images/carpentries-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo-sm.svg to #> assets/images/data-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo.svg to #> assets/images/data-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/dropdown-arrow.svg to #> assets/images/dropdown-arrow.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo-sm.svg to #> assets/images/incubator-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo.svg to #> assets/images/incubator-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo-sm.svg to #> assets/images/lab-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo.svg to #> assets/images/lab-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo-sm.svg to #> assets/images/library-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo.svg to #> assets/images/library-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/minus.svg to #> assets/images/minus.svg #> Copying <varnish>/pkgdown/assets/assets/images/plus.svg to #> assets/images/plus.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo-sm.svg to #> assets/images/software-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo.svg to #> assets/images/software-logo.svg #> Copying <varnish>/pkgdown/assets/assets/scripts.js to assets/scripts.js #> Copying <varnish>/pkgdown/assets/assets/styles.css to assets/styles.css #> Copying <varnish>/pkgdown/assets/assets/styles.css.map to #> assets/styles.css.map #> Copying <varnish>/pkgdown/assets/assets/themetoggle.js to #> assets/themetoggle.js #> Copying <varnish>/pkgdown/assets/favicon-16x16.png to favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicon-32x32.png to favicon-32x32.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-114x114.png to #> favicons/cp/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-120x120.png to #> favicons/cp/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-144x144.png to #> favicons/cp/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-152x152.png to #> favicons/cp/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-57x57.png #> to favicons/cp/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-60x60.png #> to favicons/cp/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-72x72.png #> to favicons/cp/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-76x76.png #> to favicons/cp/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-128.png to #> favicons/cp/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-16x16.png to #> favicons/cp/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-196x196.png to #> favicons/cp/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-32x32.png to #> favicons/cp/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-96x96.png to #> favicons/cp/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon.ico to #> favicons/cp/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-144x144.png to #> favicons/cp/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-150x150.png to #> favicons/cp/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x150.png to #> favicons/cp/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x310.png to #> favicons/cp/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-70x70.png to #> favicons/cp/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-114x114.png to #> favicons/dc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-120x120.png to #> favicons/dc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-144x144.png to #> favicons/dc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-152x152.png to #> favicons/dc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-57x57.png #> to favicons/dc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-60x60.png #> to favicons/dc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-72x72.png #> to favicons/dc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-76x76.png #> to favicons/dc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-128.png to #> favicons/dc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-16x16.png to #> favicons/dc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-196x196.png to #> favicons/dc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-32x32.png to #> favicons/dc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-96x96.png to #> favicons/dc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon.ico to #> favicons/dc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-144x144.png to #> favicons/dc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-150x150.png to #> favicons/dc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x150.png to #> favicons/dc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x310.png to #> favicons/dc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-70x70.png to #> favicons/dc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-114x114.png to #> favicons/lc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-120x120.png to #> favicons/lc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-144x144.png to #> favicons/lc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-152x152.png to #> favicons/lc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-57x57.png #> to favicons/lc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-60x60.png #> to favicons/lc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-72x72.png #> to favicons/lc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-76x76.png #> to favicons/lc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-128.png to #> favicons/lc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-16x16.png to #> favicons/lc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-196x196.png to #> favicons/lc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-32x32.png to #> favicons/lc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-96x96.png to #> favicons/lc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon.ico to #> favicons/lc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-144x144.png to #> favicons/lc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-150x150.png to #> favicons/lc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x150.png to #> favicons/lc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x310.png to #> favicons/lc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-70x70.png to #> favicons/lc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-114x114.png to #> favicons/swc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-120x120.png to #> favicons/swc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-144x144.png to #> favicons/swc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-152x152.png to #> favicons/swc/apple-touch-icon-152x152.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-57x57.png to #> favicons/swc/apple-touch-icon-57x57.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-60x60.png to #> favicons/swc/apple-touch-icon-60x60.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-72x72.png to #> favicons/swc/apple-touch-icon-72x72.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-76x76.png to #> favicons/swc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-128.png to #> favicons/swc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-16x16.png to #> favicons/swc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-196x196.png to #> favicons/swc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-32x32.png to #> favicons/swc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-96x96.png to #> favicons/swc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon.ico to #> favicons/swc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-144x144.png to #> favicons/swc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-150x150.png to #> favicons/swc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x150.png to #> favicons/swc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x310.png to #> favicons/swc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-70x70.png to #> favicons/swc/mstile-70x70.png #> Copying <varnish>/pkgdown/assets/mstile-150x150.png to #> mstile-150x150.png #> Copying <varnish>/pkgdown/assets/safari-pinned-tab.svg to #> safari-pinned-tab.svg #> Copying <varnish>/pkgdown/assets/site.webmanifest to site.webmanifest #> ℹ Previewing site"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_markdown.html","id":null,"dir":"Reference","previous_headings":"","what":"Build plain markdown from the RMarkdown episodes — build_markdown","title":"Build plain markdown from the RMarkdown episodes — build_markdown","text":"spirit {hugodown}, function build plain markdown files minimal R package site/ folder {sandpaper} lesson repository tagged hash file ensure files changed rebuilt.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_markdown.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build plain markdown from the RMarkdown episodes — build_markdown","text":"","code":"build_markdown(path = \".\", rebuild = FALSE, quiet = FALSE, slug = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_markdown.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build plain markdown from the RMarkdown episodes — build_markdown","text":"path path repository (defaults current working directory) rebuild TRUE, everything built scratch cache. Defaults FALSE, build markdown files built .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_markdown.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build plain markdown from the RMarkdown episodes — build_markdown","text":"TRUE successful, character vector issues unsuccessful.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Wrapper for site builder — build_site","title":"Wrapper for site builder — build_site","text":"Wrapper site builder","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Wrapper for site builder — build_site","text":"","code":"build_site( path = \".\", quiet = !interactive(), preview = TRUE, override = list(), slug = NULL, built = NULL )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_site.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Wrapper for site builder — build_site","text":"path path repository (defaults current working directory) quiet TRUE, output supressed preview TRUE, rendered website opened new window override options override (e.g. building alternative paths). used internally likely changed. slug slug file preview RStudio. NULL, preview default home page. episode whose slug 01-introduction, setting slug = \"01-introduction\" allow RStudio open preview window right page. built character vector newly built files NULL.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_site.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Wrapper for site builder — build_site","text":"assumes markdown files already built work otherwise","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_status.html","id":null,"dir":"Reference","previous_headings":"","what":"Identify what files need to be rebuilt and what need to be removed — get_hash","title":"Identify what files need to be rebuilt and what need to be removed — get_hash","text":"build_status() takes vector files compares text database files checksums. heavily adapted blogdown provide utilities removal updating old database.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_status.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Identify what files need to be rebuilt and what need to be removed — get_hash","text":"","code":"get_hash(path, db = fs::path(path_built(path), \"md5sum.txt\")) get_built_db(db = \"site/built/md5sum.txt\", filter = \"*R?md\") build_status( sources, db = \"site/built/md5sum.txt\", rebuild = FALSE, write = FALSE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_status.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Identify what files need to be rebuilt and what need to be removed — get_hash","text":"path path least one generated markdown file db path database filter regex describing files include. sources character vector source files single file rebuilt. must absolute paths rebuild files rebuilt, set TRUE (defaults FALSE) write TRUE, database updated, Defaults FALSE, meaning database remain .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_status.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Identify what files need to be rebuilt and what need to be removed — get_hash","text":"list following elements build absolute paths files build new new data frame three columns: file relative path source file checksum md5 sum source file built relative path built file date date file last updated/built remove absolute paths files remove. missing nothing remove old old database (debugging). missing old database single file rebuilt.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_status.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Identify what files need to be rebuilt and what need to be removed — get_hash","text":"get_built_db() returns text database, can filter get_hash() probably named get_expected_hash() return expected hash given file database supply single file function, assume want one file rebuilt, always return file $build element update md5 sum database (changed ). supply multiple files, indicating files care database updated accordingly, removing entries missing sources.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/build_status.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Identify what files need to be rebuilt and what need to be removed — get_hash","text":"","code":"# This demonstration will show how a temporary database can be set up. It # will only work with a sandpaper lesson # setup ----------------------------------------------------------------- tmp <- tempfile() on.exit(fs::dir_delete(tmp), add = TRUE) #> Error: [ENOENT] Failed to search directory '/tmp/RtmpQSXDNq/file1706fc5f9a3': no such file or directory create_lesson(tmp, rmd = FALSE, open = FALSE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706fc5f9a3... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706fc5f9a3... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706fc5f9a3... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706fc5f9a3... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706fc5f9a3... #> ☐ Edit /tmp/RtmpQSXDNq/file1706fc5f9a3/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706fc5f9a3... #> ✔ First episode created in /tmp/RtmpQSXDNq/file1706fc5f9a3/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706fc5f9a3... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706fc5f9a3... #> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file1706fc5f9a3 #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706fc5f9a3... #> /tmp/RtmpQSXDNq/file1706fc5f9a3 # show build status ----------------------------------------------------- # get namespace to use internal functions sp <- asNamespace(\"sandpaper\") db <- fs::path(tmp, \"site/built/md5sum.txt\") resources <- fs::path(tmp, c(\"episodes/introduction.md\", \"index.md\")) # first run, everything needs to be built and no build file exists sp$build_status(resources, db, write = TRUE) #> $build #> /tmp/RtmpQSXDNq/file1706fc5f9a3/episodes/introduction.md #> /tmp/RtmpQSXDNq/file1706fc5f9a3/index.md #> #> $new #> file #> /tmp/RtmpQSXDNq/file1706fc5f9a3/episodes/introduction.md episodes/introduction.md #> /tmp/RtmpQSXDNq/file1706fc5f9a3/index.md index.md #> checksum #> /tmp/RtmpQSXDNq/file1706fc5f9a3/episodes/introduction.md fd46501f174bb7e6cc280a1436fbc12a #> /tmp/RtmpQSXDNq/file1706fc5f9a3/index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built #> /tmp/RtmpQSXDNq/file1706fc5f9a3/episodes/introduction.md site/built/introduction.md #> /tmp/RtmpQSXDNq/file1706fc5f9a3/index.md site/built/index.md #> date #> /tmp/RtmpQSXDNq/file1706fc5f9a3/episodes/introduction.md 2024-11-07 #> /tmp/RtmpQSXDNq/file1706fc5f9a3/index.md 2024-11-07 #> # second run, everything is identical and nothing to be rebuilt sp$build_status(resources, db, write = TRUE) #> $build #> character(0) #> #> $remove #> character(0) #> #> $new #> file checksum #> 1 episodes/introduction.md fd46501f174bb7e6cc280a1436fbc12a #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-11-07 #> 2 site/built/index.md 2024-11-07 #> #> $old #> file checksum #> 1 episodes/introduction.md fd46501f174bb7e6cc280a1436fbc12a #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-11-07 #> 2 site/built/index.md 2024-11-07 #> # this is because the db exists on disk and you can query it sp$get_built_db(db, filter = \"*\") #> file checksum #> 1 episodes/introduction.md fd46501f174bb7e6cc280a1436fbc12a #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-11-07 #> 2 site/built/index.md 2024-11-07 sp$get_built_db(db, filter = \"*R?md\") #> file checksum #> 1 episodes/introduction.md fd46501f174bb7e6cc280a1436fbc12a #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-11-07 #> 2 site/built/index.md 2024-11-07 # if you get the hash of the file, it's equal to the expected: print(actual <- tools::md5sum(resources[[1]])) #> /tmp/RtmpQSXDNq/file1706fc5f9a3/episodes/introduction.md #> \"fd46501f174bb7e6cc280a1436fbc12a\" print(expected <- sp$get_hash(resources[[1]], db)) #> [1] \"fd46501f174bb7e6cc280a1436fbc12a\" unname(actual == expected) #> [1] TRUE # replaced files need to be rebuilt ------------------------------------- # if we change the introduction to an R Markdown file, the build will # see this as a deleted file and re-added file. cat(\"This is now an R Markdown document and the time is `r Sys.time()`\\n\", file = resources[[1]], append = TRUE) fs::file_move(resources[[1]], fs::path_ext_set(resources[[1]], \"Rmd\")) resources[[1]] <- fs::path_ext_set(resources[[1]], \"Rmd\") set_episodes(tmp, fs::path_file(resources[[1]]), write = TRUE) sp$build_status(resources, db, write = TRUE) #> $build #> /tmp/RtmpQSXDNq/file1706fc5f9a3/episodes/introduction.Rmd #> #> $remove #> /tmp/RtmpQSXDNq/file1706fc5f9a3/site/built/introduction.md #> #> $new #> file checksum #> 2 episodes/introduction.Rmd 42f28ae9ac714f87eb912bfccf614cab #> 1 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 2 site/built/introduction.md 2024-11-07 #> 1 site/built/index.md 2024-11-07 #> #> $old #> file checksum #> 1 episodes/introduction.md fd46501f174bb7e6cc280a1436fbc12a #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-11-07 #> 2 site/built/index.md 2024-11-07 #> # modified files need to be rebuilt ------------------------------------- cat(\"We are using `r R.version.string`\\n\", file = resources[[1]], append = TRUE) sp$build_status(resources, db, write = TRUE) #> $build #> /tmp/RtmpQSXDNq/file1706fc5f9a3/episodes/introduction.Rmd #> #> $remove #> character(0) #> #> $new #> file checksum #> 1 episodes/introduction.Rmd 700f007bdd7e8fd6e3f7011f80dacf7b #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-11-07 #> 2 site/built/index.md 2024-11-07 #> #> $old #> file checksum #> 1 episodes/introduction.Rmd 42f28ae9ac714f87eb912bfccf614cab #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-11-07 #> 2 site/built/index.md 2024-11-07 #> # child files require rebuilding ---------------------------------------- writeLines(\"Hello from another file!\\n\", fs::path(tmp, \"episodes\", \"files\", \"hi.md\")) cat(\"\\n\\n```{r child='files/hi.md'}\\n```\\n\", file = resources[[1]], append = TRUE) sp$build_status(resources, db, write = TRUE) #> $build #> /tmp/RtmpQSXDNq/file1706fc5f9a3/episodes/introduction.Rmd #> #> $remove #> character(0) #> #> $new #> file checksum #> 1 episodes/introduction.Rmd 4a0b39645c21579d9992ad3b50d623e4 #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-11-07 #> 2 site/built/index.md 2024-11-07 #> #> $old #> file checksum #> 1 episodes/introduction.Rmd 700f007bdd7e8fd6e3f7011f80dacf7b #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-11-07 #> 2 site/built/index.md 2024-11-07 #> # NOTE: for child files, the checksums are the checksum of the checksums # of the parent and children, so the file checksum may not make sense # changing a child file rebuilds the parent ---------------------------- cat(\"Goodbye!\\n\", append = TRUE, file = fs::path(tmp, \"episodes\", \"files\", \"hi.md\")) sp$build_status(resources, db, write = TRUE) #> $build #> /tmp/RtmpQSXDNq/file1706fc5f9a3/episodes/introduction.Rmd #> #> $remove #> character(0) #> #> $new #> file checksum #> 1 episodes/introduction.Rmd 2ab510dfa3fbd1f224ab3c20547391ea #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-11-07 #> 2 site/built/index.md 2024-11-07 #> #> $old #> file checksum #> 1 episodes/introduction.Rmd 4a0b39645c21579d9992ad3b50d623e4 #> 2 index.md a02c9c785ed98ddd84fe3d34ddb12fcd #> built date #> 1 site/built/introduction.md 2024-11-07 #> 2 site/built/index.md 2024-11-07 #>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_lesson.html","id":null,"dir":"Reference","previous_headings":"","what":"deprecated Check the lesson structure for errors — check_lesson","title":"deprecated Check the lesson structure for errors — check_lesson","text":"function now deprecated favour validate_lesson().","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_lesson.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"deprecated Check the lesson structure for errors — check_lesson","text":"","code":"check_lesson(path = \".\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_lesson.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"deprecated Check the lesson structure for errors — check_lesson","text":"path path lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_lesson.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"deprecated Check the lesson structure for errors — check_lesson","text":"TRUE (invisibly) lesson cromulent, otherwise, error list things fix.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_lesson.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"deprecated Check the lesson structure for errors — check_lesson","text":"","code":"# Everything should work out of the box tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file170658067e6e... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpQSXDNq/file170658067e6e... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpQSXDNq/file170658067e6e... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpQSXDNq/file170658067e6e... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file170658067e6e... #> ☐ Edit /tmp/RtmpQSXDNq/file170658067e6e/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpQSXDNq/file170658067e6e... #> ✔ First episode created in /tmp/RtmpQSXDNq/file170658067e6e/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpQSXDNq/file170658067e6e... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpQSXDNq/file170658067e6e... #> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file170658067e6e #> → Creating Lesson in /tmp/RtmpQSXDNq/file170658067e6e... #> /tmp/RtmpQSXDNq/file170658067e6e check_lesson(tmp) # if things do not work, then an error is thrown with information about # what has failed you unlink(file.path(tmp, \".gitignore\")) unlink(file.path(tmp, \"site\"), recursive = TRUE) try(check_lesson(tmp)) #> ! Path '/tmp/RtmpQSXDNq/file170658067e6e/site' does not exist #> ! The .gitignore file is missing the following elements: #> episodes/*html #> site/* #> !site/README.md #> .Rhistory #> .Rapp.history #> .RData #> .Ruserdata #> *-Ex.R #> /*.tar.gz #> /*.Rcheck/ #> .Rproj.user/ #> vignettes/*.html #> vignettes/*.pdf #> .httr-oauth #> *_cache/ #> /cache/ #> *.utf8.md #> *.knit.md #> .Renviron #> docs/ #> po/*~ #> ! The file 'site/README.md' does not exist #> Error in report_validation(checklist, \"There were errors with the lesson structure.\") : #> There were errors with the lesson structure. unlink(tmp)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_pandoc.html","id":null,"dir":"Reference","previous_headings":"","what":"Check the existence of pandoc — check_pandoc","title":"Check the existence of pandoc — check_pandoc","text":"function adds context rmarkdown::pandoc_available() provides error message directing user download latest version pandoc RStudio Desktop.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_pandoc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check the existence of pandoc — check_pandoc","text":"","code":"check_pandoc(quiet = TRUE, pv = \"2.11\", rv = \"1.4\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_pandoc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check the existence of pandoc — check_pandoc","text":"quiet TRUE, message emitted, otherwise pandoc version path sent message (stderr) screen. pv minimum pandoc version rv minimum rstudio version (available)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/check_pandoc.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check the existence of pandoc — check_pandoc","text":"","code":"# NOTE: this is an internal function, so there is no guarantee that the usage # will remain the same across time. This is merely for demonstration purposes # only. # Check for pandoc ---------------------- asNamespace(\"sandpaper\")$check_pandoc(quiet = FALSE) #> ◉ pandoc found #> version : 3.1.11 #> path : /opt/hostedtoolcache/pandoc/3.1.11/x64 # Message emitted when pandoc cannot be found -------- try(asNamespace(\"sandpaper\")$check_pandoc(quiet = FALSE, pv = \"999\")) #> sandpaper requires pandoc version 999 or higher. #> ! You have pandoc version 3.1.11 in /opt/hostedtoolcache/pandoc/3.1.11/x64 #> → Please visit <https://pandoc.org/installing.html> to install the latest version. #> Error : Incorrect pandoc version"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":null,"dir":"Reference","previous_headings":"","what":"Build and deploy individual site components to a remote branch — ci_build_markdown","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"internal functions provision deploy lesson components orphan git branches. called ci_deploy(). functions side-effect creating updating orphan branches remote repository. assumed access remote.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"","code":"ci_build_markdown( path = \".\", branch = \"md-outputs\", remote = \"origin\", reset = FALSE ) ci_build_site( path = \".\", branch = \"gh-pages\", md = \"md-outputs\", remote = \"origin\", reset = FALSE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"path path lesson branch branch name containing output: ci_build_markdown(): defaults md-output, corresponds md_branch ci_deploy() ci_build_site(): defaults gh-pages, corresponds site_branch ci_deploy() remote name git remote deploy. reset TRUE, markdown cache cleared rebuilding, defaults FALSE meaning markdown cache provisioned used. md branch name contains markdown outputs","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"ci_build_markdown(): expression() evaluated tear worktree created. ci_build_site(): nothing, used side-effect.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"place two functions used within ci_deploy(), de-facto use-case functions, thus, page examples. functions general process: provision git worktree appropriate folder git_worktree_setup() build requisite content folder commit push contents worktree github_worktree_commit() caveats two functions listed sections .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":"ci-build-markdown-","dir":"Reference","previous_headings":"","what":"ci_build_markdown()","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"clean default. must save output object run eval(obj) run clean process. place ci_build_site() can use worktree markdown outputs order build site.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":"ci-build-site-","dir":"Reference","previous_headings":"","what":"ci_build_site()","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"addition steps listed , function needs verify materials necessary build HTML site. first checks presence site/built/. folder can generated ci_build_markdown() build_markdown(). folder exist empty, function attempt fetch folder branch md. everything built pushed, function additionally destroy work tree.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_build.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Build and deploy individual site components to a remote branch — ci_build_markdown","text":"ci_build_markdown() set sandpaper.use_renv option TRUE, means always use {renv} package cache lesson uses R Markdown.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":null,"dir":"Reference","previous_headings":"","what":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"platform-agnostic method deploying lesson website cached content. function takes advantage git worktrees render push content orphan branches, can used host lesson website. function assumes git clone remote write access remote.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"","code":"ci_deploy( path = \".\", md_branch = \"md-outputs\", site_branch = \"gh-pages\", remote = \"origin\", reset = FALSE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"path path lesson md_branch branch name contains markdown outputs site_branch branch name contains full HTML site remote name git remote deploy. reset TRUE, markdown cache cleared rebuilding, defaults FALSE meaning markdown cache provisioned used.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"Nothing, invisibly. used side-effect","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"ci_deploy() thing build_lesson(), except instead storing outputs site/ folder, pushes outputs remote orphan branches (determined md_branch site_branch arguments). branches used cache website, respectively. branches exist, created.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"requirements","dir":"Reference","previous_headings":"","what":"Requirements","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"function can run non-interactive fashion. try run interactively, get error message. assumes following true: running script automated workflow running clone git repository remote exists writable Unexpected consequences can arise violating assumptions.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"workflow","dir":"Reference","previous_headings":"","what":"Workflow","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"function similar two-step workflow build_lesson(), extra steps ensure git branches set correctly. steps elements common build_lesson() annotated * check git user email registered * Validate lesson generate global variables validate_lesson() provision, build, deploy markdown branch ci_build_markdown() . provision markdown branch git_worktree_setup() ii. * build markdown source documents build_markdown() iii. commit push git worktree remote branch github_worktree_commit() provision, build, deploy site branch ci_build_site() . provision site branch git_worktree_setup() ii. * build site HTML documents build_site() iii. commit push git worktree remote branch github_worktree_commit() iv. remove git worktree github_worktree_remove() remove markdown git worktree github_worktree_remove()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"function interactive use. requires git installed machine destroy anything site/ folder. R-based lessons rebuild components lockfile changed.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_deploy.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"(INTERNAL) Build and deploy the site with continous integration — ci_deploy","text":"","code":"# For this example, we are setting up a temporary repository with a local # remote called `sandpaper-local`. This demonstrates how `ci_deploy()` # modifies the remote, but there are setup and teardown steps to run. # The actual example is highlighted below under the DEPLOY comment. # SETUP ------------------------------------------------------------------- snd <- asNamespace(\"sandpaper\") tik <- Sys.time() cli::cli_h1(\"Set up\") #> #> ── Set up ────────────────────────────────────────────────────────────── cli::cli_h2(\"Create Lesson\") #> #> ── Create Lesson ── #> restore_fixture <- snd$create_test_lesson() #> → Bootstrapping example lesson #> ℹ Lesson bootstrapped in 3.164504 secs #> → Bootstrapping example lesson res <- getOption(\"sandpaper.test_fixture\") cli::cli_h2(\"Create Remote\") #> #> ── Create Remote ── #> rmt <- fs::file_temp(pattern = \"REMOTE-\") snd$setup_local_remote(repo = res, remote = rmt, verbose = FALSE) #> ℹ Remote set up in 0.01416016 secs tok <- Sys.time() cli::cli_alert_info(\"Elapsed time: {round(tok - tik, 2)} seconds\") #> ℹ Elapsed time: 3.21 seconds # reporting ----- # The repository should only have one branch and the remote should be in # sync with the local. cli::cli_h2(\"Local status\") #> #> ── Local status ── #> gert::git_branch_list(repo = res)[c('name', 'commit', 'updated')] #> # A tibble: 2 × 3 #> name commit updated #> <chr> <chr> <dttm> #> 1 main 22a7c95023db2822803f584dbe79… 2024-11-07 18:54:40 #> 2 sandpaper-local/main 22a7c95023db2822803f584dbe79… 2024-11-07 18:54:40 cli::cli_h2(\"First episode status\") #> ── First episode status ── #> gert::git_stat_files(\"episodes/introduction.Rmd\", repo = res) #> # A tibble: 1 × 5 #> file created modified commits head #> * <chr> <dttm> <dttm> <int> <chr> #> 1 episodes/introd… 2024-11-07 18:54:40 2024-11-07 18:54:40 1 22a7… gert::git_stat_files(\"episodes/introduction.Rmd\", repo = rmt) #> # A tibble: 1 × 5 #> file created modified commits head #> * <chr> <dttm> <dttm> <int> <chr> #> 1 episodes/introd… 2024-11-07 18:54:40 2024-11-07 18:54:40 1 22a7… # DEPLOY ------------------------------------------------------------------ tik <- Sys.time() cli::cli_h1(\"deploy to remote\") #> ── deploy to remote ──────────────────────────────────────────────────── sandpaper:::ci_deploy(path = res, remote = \"sandpaper-local\") #> ── Validating Fenced Divs ────────────────────────────────────────────── #> ── Validating Internal Links and Images ──────────────────────────────── #> ::group::Create New Branch #> Running git checkout --orphan md-outputs #> Switched to a new branch 'md-outputs' #> Running git rm -rf --quiet . #> Running git commit --allow-empty -m 'Initializing md-outputs branch' #> [md-outputs (root-commit) 4d8e9bc] Initializing md-outputs branch #> Running git push sandpaper-local 'HEAD:md-outputs' #> To /tmp/RtmpQSXDNq/REMOTE-17062f1ff59f #> * [new branch] HEAD -> md-outputs #> Running git checkout main #> Switched to branch 'main' #> Your branch is up to date with 'sandpaper-local/main'. #> ::endgroup:: #> ::group::Fetch sandpaper-local/md-outputs #> Running git remote set-branches sandpaper-local md-outputs #> Running git fetch sandpaper-local md-outputs #> From /tmp/RtmpQSXDNq/REMOTE-17062f1ff59f #> * branch md-outputs -> FETCH_HEAD #> Running git remote set-branches sandpaper-local '*' #> ::endgroup:: #> ::group::Add worktree for sandpaper-local/md-outputs in site/built #> Running git worktree add --track -B md-outputs \\ #> /tmp/RtmpQSXDNq/file17065ef9650b/lesson-example/site/built \\ #> sandpaper-local/md-outputs #> Preparing worktree (resetting branch 'md-outputs'; was at 4d8e9bc) #> branch 'md-outputs' set up to track 'sandpaper-local/md-outputs'. #> HEAD is now at 4d8e9bc Initializing md-outputs branch #> ::endgroup:: #> ::group::Build Markdown Sources #> ℹ Consent to use package cache provided #> → Searching for and installing available dependencies #> Finding R package dependencies ... Done! #> → Restoring any dependency versions #> - The library is already synchronized with the lockfile. #> → Recording changes in lockfile #> - The lockfile is already up to date. #> ℹ Using package cache in /home/runner/.cache/R/renv #> #> #> processing file: /tmp/RtmpQSXDNq/file17065ef9650b/lesson-example/episodes/introduction.Rmd #> 1/3 #> 2/3 [pyramid] #> 3/3 #> output file: /tmp/RtmpQSXDNq/file17065ef9650b/lesson-example/site/built/introduction.md #> #> ::endgroup:: #> ::group::Commit Markdown Sources #> Running git commit --allow-empty -m \\ #> 'markdown source builds #> #> Auto-generated via `{sandpaper}` #> Source : 22a7c95023db2822803f584dbe79c30723816236 #> Branch : main #> Author : carpenter <team@carpentries.org> #> Time : 2024-11-07 18:54:40 +0000 #> Message : Initial commit [via `{sandpaper}`] #> ' #> [md-outputs bf68155] markdown source builds #> 13 files changed, 737 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 #> Running git remote -v #> sandpaper-local\t/tmp/RtmpQSXDNq/REMOTE-17062f1ff59f (fetch) #> sandpaper-local\t/tmp/RtmpQSXDNq/REMOTE-17062f1ff59f (push) #> Running git push --force sandpaper-local 'HEAD:md-outputs' #> To /tmp/RtmpQSXDNq/REMOTE-17062f1ff59f #> 4d8e9bc..bf68155 HEAD -> md-outputs #> ::endgroup:: #> ::group::Create New Branch #> Running git checkout --orphan gh-pages #> Switched to a new branch 'gh-pages' #> Running git rm -rf --quiet . #> Running git commit --allow-empty -m 'Initializing gh-pages branch' #> [gh-pages (root-commit) 344b40d] Initializing gh-pages branch #> Running git push sandpaper-local 'HEAD:gh-pages' #> To /tmp/RtmpQSXDNq/REMOTE-17062f1ff59f #> * [new branch] HEAD -> gh-pages #> Running git checkout main #> Switched to branch 'main' #> Your branch is up to date with 'sandpaper-local/main'. #> ::endgroup:: #> ::group::Fetch sandpaper-local/gh-pages #> Running git remote set-branches sandpaper-local gh-pages #> Running git fetch sandpaper-local gh-pages #> From /tmp/RtmpQSXDNq/REMOTE-17062f1ff59f #> * branch gh-pages -> FETCH_HEAD #> Running git remote set-branches sandpaper-local '*' #> ::endgroup:: #> ::group::Add worktree for sandpaper-local/gh-pages in site/docs #> Running git worktree add --track -B gh-pages \\ #> /tmp/RtmpQSXDNq/file17065ef9650b/lesson-example/site/docs \\ #> sandpaper-local/gh-pages #> Preparing worktree (resetting branch 'gh-pages'; was at 344b40d) #> branch 'gh-pages' set up to track 'sandpaper-local/gh-pages'. #> HEAD is now at 344b40d Initializing gh-pages branch #> ::endgroup:: #> ::group::Build Lesson Website #> ◉ pandoc found #> version : 3.1.11 #> path : /opt/hostedtoolcache/pandoc/3.1.11/x64 #> ── Initialising site ─────────────────────────────────────────────────── #> Copying <pkgdown>/BS3/assets/bootstrap-toc.css to bootstrap-toc.css #> Copying <pkgdown>/BS3/assets/bootstrap-toc.js to bootstrap-toc.js #> Copying <pkgdown>/BS3/assets/docsearch.css to docsearch.css #> Copying <pkgdown>/BS3/assets/docsearch.js to docsearch.js #> Copying <pkgdown>/BS3/assets/link.svg to link.svg #> Copying <pkgdown>/BS3/assets/pkgdown.css to pkgdown.css #> Copying <pkgdown>/BS3/assets/pkgdown.js to pkgdown.js #> Copying <varnish>/pkgdown/assets/android-chrome-192x192.png to #> android-chrome-192x192.png #> Copying <varnish>/pkgdown/assets/android-chrome-512x512.png to #> android-chrome-512x512.png #> Copying <varnish>/pkgdown/assets/apple-touch-icon.png to #> apple-touch-icon.png #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.eot to #> assets/fonts/Mulish-Black.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.svg to #> assets/fonts/Mulish-Black.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.ttf to #> assets/fonts/Mulish-Black.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.woff to #> assets/fonts/Mulish-Black.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.woff2 to #> assets/fonts/Mulish-Black.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.eot to #> assets/fonts/Mulish-BlackItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.svg to #> assets/fonts/Mulish-BlackItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.ttf to #> assets/fonts/Mulish-BlackItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.woff #> to assets/fonts/Mulish-BlackItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.woff2 #> to assets/fonts/Mulish-BlackItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.eot to #> assets/fonts/Mulish-Bold.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.svg to #> assets/fonts/Mulish-Bold.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.ttf to #> assets/fonts/Mulish-Bold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.woff to #> assets/fonts/Mulish-Bold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.woff2 to #> assets/fonts/Mulish-Bold.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.eot to #> assets/fonts/Mulish-BoldItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.svg to #> assets/fonts/Mulish-BoldItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.ttf to #> assets/fonts/Mulish-BoldItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.woff to #> assets/fonts/Mulish-BoldItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.woff2 #> to assets/fonts/Mulish-BoldItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.eot to #> assets/fonts/Mulish-ExtraBold.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.svg to #> assets/fonts/Mulish-ExtraBold.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.ttf to #> assets/fonts/Mulish-ExtraBold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.woff to #> assets/fonts/Mulish-ExtraBold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.woff2 to #> assets/fonts/Mulish-ExtraBold.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.eot to #> assets/fonts/Mulish-ExtraBoldItalic.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.svg to #> assets/fonts/Mulish-ExtraBoldItalic.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.ttf to #> assets/fonts/Mulish-ExtraBoldItalic.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.woff to #> assets/fonts/Mulish-ExtraBoldItalic.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.woff2 to #> assets/fonts/Mulish-ExtraBoldItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.eot to #> assets/fonts/Mulish-ExtraLight.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.svg to #> assets/fonts/Mulish-ExtraLight.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.ttf to #> assets/fonts/Mulish-ExtraLight.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.woff to #> assets/fonts/Mulish-ExtraLight.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.woff2 #> to assets/fonts/Mulish-ExtraLight.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.eot to #> assets/fonts/Mulish-ExtraLightItalic.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.svg to #> assets/fonts/Mulish-ExtraLightItalic.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.ttf to #> assets/fonts/Mulish-ExtraLightItalic.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.woff to #> assets/fonts/Mulish-ExtraLightItalic.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.woff2 to #> assets/fonts/Mulish-ExtraLightItalic.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic-VariableFont_wght.ttf #> to assets/fonts/Mulish-Italic-VariableFont_wght.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.eot to #> assets/fonts/Mulish-Italic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.svg to #> assets/fonts/Mulish-Italic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.ttf to #> assets/fonts/Mulish-Italic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.woff to #> assets/fonts/Mulish-Italic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.woff2 to #> assets/fonts/Mulish-Italic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.eot to #> assets/fonts/Mulish-Light.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.svg to #> assets/fonts/Mulish-Light.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.ttf to #> assets/fonts/Mulish-Light.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.woff to #> assets/fonts/Mulish-Light.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.woff2 to #> assets/fonts/Mulish-Light.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.eot to #> assets/fonts/Mulish-LightItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.svg to #> assets/fonts/Mulish-LightItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.ttf to #> assets/fonts/Mulish-LightItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.woff #> to assets/fonts/Mulish-LightItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.woff2 #> to assets/fonts/Mulish-LightItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.eot to #> assets/fonts/Mulish-Medium.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.svg to #> assets/fonts/Mulish-Medium.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.ttf to #> assets/fonts/Mulish-Medium.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.woff to #> assets/fonts/Mulish-Medium.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.woff2 to #> assets/fonts/Mulish-Medium.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.eot #> to assets/fonts/Mulish-MediumItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.svg #> to assets/fonts/Mulish-MediumItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.ttf #> to assets/fonts/Mulish-MediumItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.woff #> to assets/fonts/Mulish-MediumItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.woff2 #> to assets/fonts/Mulish-MediumItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.eot to #> assets/fonts/Mulish-Regular.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.svg to #> assets/fonts/Mulish-Regular.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.ttf to #> assets/fonts/Mulish-Regular.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.woff to #> assets/fonts/Mulish-Regular.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.woff2 to #> assets/fonts/Mulish-Regular.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.eot to #> assets/fonts/Mulish-SemiBold.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.svg to #> assets/fonts/Mulish-SemiBold.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.ttf to #> assets/fonts/Mulish-SemiBold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.woff to #> assets/fonts/Mulish-SemiBold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.woff2 to #> assets/fonts/Mulish-SemiBold.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.eot #> to assets/fonts/Mulish-SemiBoldItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.svg #> to assets/fonts/Mulish-SemiBoldItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.ttf #> to assets/fonts/Mulish-SemiBoldItalic.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.woff to #> assets/fonts/Mulish-SemiBoldItalic.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.woff2 to #> assets/fonts/Mulish-SemiBoldItalic.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-VariableFont_wght.ttf to #> assets/fonts/Mulish-VariableFont_wght.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.eot to #> assets/fonts/MulishExtraLight-Regular.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.svg to #> assets/fonts/MulishExtraLight-Regular.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.woff to #> assets/fonts/MulishExtraLight-Regular.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.woff2 to #> assets/fonts/MulishExtraLight-Regular.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.eot to #> assets/fonts/mulish-v5-latin-regular.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.svg to #> assets/fonts/mulish-v5-latin-regular.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.ttf to #> assets/fonts/mulish-v5-latin-regular.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff to #> assets/fonts/mulish-v5-latin-regular.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff2 to #> assets/fonts/mulish-v5-latin-regular.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff to #> assets/fonts/mulish-variablefont_wght.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff2 to #> assets/fonts/mulish-variablefont_wght.woff2 #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo-sm.svg #> to assets/images/carpentries-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo.svg to #> assets/images/carpentries-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo-sm.svg to #> assets/images/data-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo.svg to #> assets/images/data-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/dropdown-arrow.svg to #> assets/images/dropdown-arrow.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo-sm.svg to #> assets/images/incubator-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo.svg to #> assets/images/incubator-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo-sm.svg to #> assets/images/lab-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo.svg to #> assets/images/lab-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo-sm.svg to #> assets/images/library-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo.svg to #> assets/images/library-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/minus.svg to #> assets/images/minus.svg #> Copying <varnish>/pkgdown/assets/assets/images/plus.svg to #> assets/images/plus.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo-sm.svg to #> assets/images/software-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo.svg to #> assets/images/software-logo.svg #> Copying <varnish>/pkgdown/assets/assets/scripts.js to assets/scripts.js #> Copying <varnish>/pkgdown/assets/assets/styles.css to assets/styles.css #> Copying <varnish>/pkgdown/assets/assets/styles.css.map to #> assets/styles.css.map #> Copying <varnish>/pkgdown/assets/assets/themetoggle.js to #> assets/themetoggle.js #> Copying <varnish>/pkgdown/assets/favicon-16x16.png to favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicon-32x32.png to favicon-32x32.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-114x114.png to #> favicons/cp/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-120x120.png to #> favicons/cp/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-144x144.png to #> favicons/cp/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-152x152.png to #> favicons/cp/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-57x57.png #> to favicons/cp/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-60x60.png #> to favicons/cp/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-72x72.png #> to favicons/cp/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-76x76.png #> to favicons/cp/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-128.png to #> favicons/cp/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-16x16.png to #> favicons/cp/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-196x196.png to #> favicons/cp/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-32x32.png to #> favicons/cp/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-96x96.png to #> favicons/cp/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon.ico to #> favicons/cp/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-144x144.png to #> favicons/cp/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-150x150.png to #> favicons/cp/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x150.png to #> favicons/cp/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x310.png to #> favicons/cp/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-70x70.png to #> favicons/cp/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-114x114.png to #> favicons/dc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-120x120.png to #> favicons/dc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-144x144.png to #> favicons/dc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-152x152.png to #> favicons/dc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-57x57.png #> to favicons/dc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-60x60.png #> to favicons/dc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-72x72.png #> to favicons/dc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-76x76.png #> to favicons/dc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-128.png to #> favicons/dc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-16x16.png to #> favicons/dc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-196x196.png to #> favicons/dc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-32x32.png to #> favicons/dc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-96x96.png to #> favicons/dc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon.ico to #> favicons/dc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-144x144.png to #> favicons/dc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-150x150.png to #> favicons/dc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x150.png to #> favicons/dc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x310.png to #> favicons/dc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-70x70.png to #> favicons/dc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-114x114.png to #> favicons/lc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-120x120.png to #> favicons/lc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-144x144.png to #> favicons/lc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-152x152.png to #> favicons/lc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-57x57.png #> to favicons/lc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-60x60.png #> to favicons/lc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-72x72.png #> to favicons/lc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-76x76.png #> to favicons/lc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-128.png to #> favicons/lc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-16x16.png to #> favicons/lc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-196x196.png to #> favicons/lc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-32x32.png to #> favicons/lc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-96x96.png to #> favicons/lc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon.ico to #> favicons/lc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-144x144.png to #> favicons/lc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-150x150.png to #> favicons/lc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x150.png to #> favicons/lc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x310.png to #> favicons/lc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-70x70.png to #> favicons/lc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-114x114.png to #> favicons/swc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-120x120.png to #> favicons/swc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-144x144.png to #> favicons/swc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-152x152.png to #> favicons/swc/apple-touch-icon-152x152.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-57x57.png to #> favicons/swc/apple-touch-icon-57x57.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-60x60.png to #> favicons/swc/apple-touch-icon-60x60.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-72x72.png to #> favicons/swc/apple-touch-icon-72x72.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-76x76.png to #> favicons/swc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-128.png to #> favicons/swc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-16x16.png to #> favicons/swc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-196x196.png to #> favicons/swc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-32x32.png to #> favicons/swc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-96x96.png to #> favicons/swc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon.ico to #> favicons/swc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-144x144.png to #> favicons/swc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-150x150.png to #> favicons/swc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x150.png to #> favicons/swc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x310.png to #> favicons/swc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-70x70.png to #> favicons/swc/mstile-70x70.png #> Copying <varnish>/pkgdown/assets/mstile-150x150.png to #> mstile-150x150.png #> Copying <varnish>/pkgdown/assets/safari-pinned-tab.svg to #> safari-pinned-tab.svg #> Copying <varnish>/pkgdown/assets/site.webmanifest to site.webmanifest #> ── Scanning episodes to rebuild ──────────────────────────────────────── #> Writing `instructor/CODE_OF_CONDUCT.html` #> Writing `CODE_OF_CONDUCT.html` #> Writing `instructor/LICENSE.html` #> Writing `LICENSE.html` #> Writing `instructor/introduction.html` #> Writing `introduction.html` #> Writing `instructor/reference.html` #> Writing `reference.html` #> ── Creating 404 page ─────────────────────────────────────────────────── #> Writing `instructor/404.html` #> Writing `404.html` #> ── Creating learner profiles ─────────────────────────────────────────── #> Writing `instructor/profiles.html` #> Writing `profiles.html` #> ── Creating homepage ─────────────────────────────────────────────────── #> Writing `instructor/index.html` #> Writing `index.html` #> ── Creating keypoints summary ────────────────────────────────────────── #> Writing 'instructor/key-points.html' #> Writing 'key-points.html' #> ── Creating All-in-one page ──────────────────────────────────────────── #> Writing 'instructor/aio.html' #> Writing 'aio.html' #> ── Creating Images page ──────────────────────────────────────────────── #> Writing 'instructor/images.html' #> Writing 'images.html' #> ── Creating Instructor Notes ─────────────────────────────────────────── #> Writing 'instructor/instructor-notes.html' #> Writing 'instructor-notes.html' #> ── Creating sitemap.xml ──────────────────────────────────────────────── #> #> Output created: /tmp/RtmpQSXDNq/file17065ef9650b/lesson-example/site/docs/index.html #> ::endgroup:: #> ::group::Commit Lesson Website #> Running git commit --allow-empty -m \\ #> 'site deploy #> #> Auto-generated via `{sandpaper}` #> Source : bf6815545b4377ff7c87113ba2b3104227aba966 #> Branch : md-outputs #> Author : GitHub Actions <actions@github.com> #> Time : 2024-11-07 18:54:43 +0000 #> Message : markdown source builds #> #> Auto-generated via `{sandpaper}` #> Source : 22a7c95023db2822803f584dbe79c30723816236 #> Branch : main #> Author : carpenter <team@carpentries.org> #> Time : 2024-11-07 18:54:40 +0000 #> Message : Initial commit [via `{sandpaper}`] #> ' #> [gh-pages eedb7fc] site deploy #> 232 files changed, 149495 insertions(+) #> create mode 100644 .nojekyll #> create mode 100644 404.html #> create mode 100644 CODE_OF_CONDUCT.html #> create mode 100644 LICENSE.html #> create mode 100644 aio.html #> create mode 100644 android-chrome-192x192.png #> create mode 100644 android-chrome-512x512.png #> create mode 100644 apple-touch-icon.png #> create mode 100644 assets/fonts/Mulish-Black.eot #> create mode 100644 assets/fonts/Mulish-Black.svg #> create mode 100644 assets/fonts/Mulish-Black.ttf #> create mode 100644 assets/fonts/Mulish-Black.woff #> create mode 100644 assets/fonts/Mulish-Black.woff2 #> create mode 100644 assets/fonts/Mulish-BlackItalic.eot #> create mode 100644 assets/fonts/Mulish-BlackItalic.svg #> create mode 100644 assets/fonts/Mulish-BlackItalic.ttf #> create mode 100644 assets/fonts/Mulish-BlackItalic.woff #> create mode 100644 assets/fonts/Mulish-BlackItalic.woff2 #> create mode 100644 assets/fonts/Mulish-Bold.eot #> create mode 100644 assets/fonts/Mulish-Bold.svg #> create mode 100644 assets/fonts/Mulish-Bold.ttf #> create mode 100644 assets/fonts/Mulish-Bold.woff #> create mode 100644 assets/fonts/Mulish-Bold.woff2 #> create mode 100644 assets/fonts/Mulish-BoldItalic.eot #> create mode 100644 assets/fonts/Mulish-BoldItalic.svg #> create mode 100644 assets/fonts/Mulish-BoldItalic.ttf #> create mode 100644 assets/fonts/Mulish-BoldItalic.woff #> create mode 100644 assets/fonts/Mulish-BoldItalic.woff2 #> create mode 100644 assets/fonts/Mulish-ExtraBold.eot #> create mode 100644 assets/fonts/Mulish-ExtraBold.svg #> create mode 100644 assets/fonts/Mulish-ExtraBold.ttf #> create mode 100644 assets/fonts/Mulish-ExtraBold.woff #> create mode 100644 assets/fonts/Mulish-ExtraBold.woff2 #> create mode 100644 assets/fonts/Mulish-ExtraBoldItalic.eot #> create mode 100644 assets/fonts/Mulish-ExtraBoldItalic.svg #> create mode 100644 assets/fonts/Mulish-ExtraBoldItalic.ttf #> create mode 100644 assets/fonts/Mulish-ExtraBoldItalic.woff #> create mode 100644 assets/fonts/Mulish-ExtraBoldItalic.woff2 #> create mode 100644 assets/fonts/Mulish-ExtraLight.eot #> create mode 100644 assets/fonts/Mulish-ExtraLight.svg #> create mode 100644 assets/fonts/Mulish-ExtraLight.ttf #> create mode 100644 assets/fonts/Mulish-ExtraLight.woff #> create mode 100644 assets/fonts/Mulish-ExtraLight.woff2 #> create mode 100644 assets/fonts/Mulish-ExtraLightItalic.eot #> create mode 100644 assets/fonts/Mulish-ExtraLightItalic.svg #> create mode 100644 assets/fonts/Mulish-ExtraLightItalic.ttf #> create mode 100644 assets/fonts/Mulish-ExtraLightItalic.woff #> create mode 100644 assets/fonts/Mulish-ExtraLightItalic.woff2 #> create mode 100644 assets/fonts/Mulish-Italic-VariableFont_wght.ttf #> create mode 100644 assets/fonts/Mulish-Italic.eot #> create mode 100644 assets/fonts/Mulish-Italic.svg #> create mode 100644 assets/fonts/Mulish-Italic.ttf #> create mode 100644 assets/fonts/Mulish-Italic.woff #> create mode 100644 assets/fonts/Mulish-Italic.woff2 #> create mode 100644 assets/fonts/Mulish-Light.eot #> create mode 100644 assets/fonts/Mulish-Light.svg #> create mode 100644 assets/fonts/Mulish-Light.ttf #> create mode 100644 assets/fonts/Mulish-Light.woff #> create mode 100644 assets/fonts/Mulish-Light.woff2 #> create mode 100644 assets/fonts/Mulish-LightItalic.eot #> create mode 100644 assets/fonts/Mulish-LightItalic.svg #> create mode 100644 assets/fonts/Mulish-LightItalic.ttf #> create mode 100644 assets/fonts/Mulish-LightItalic.woff #> create mode 100644 assets/fonts/Mulish-LightItalic.woff2 #> create mode 100644 assets/fonts/Mulish-Medium.eot #> create mode 100644 assets/fonts/Mulish-Medium.svg #> create mode 100644 assets/fonts/Mulish-Medium.ttf #> create mode 100644 assets/fonts/Mulish-Medium.woff #> create mode 100644 assets/fonts/Mulish-Medium.woff2 #> create mode 100644 assets/fonts/Mulish-MediumItalic.eot #> create mode 100644 assets/fonts/Mulish-MediumItalic.svg #> create mode 100644 assets/fonts/Mulish-MediumItalic.ttf #> create mode 100644 assets/fonts/Mulish-MediumItalic.woff #> create mode 100644 assets/fonts/Mulish-MediumItalic.woff2 #> create mode 100644 assets/fonts/Mulish-Regular.eot #> create mode 100644 assets/fonts/Mulish-Regular.svg #> create mode 100644 assets/fonts/Mulish-Regular.ttf #> create mode 100644 assets/fonts/Mulish-Regular.woff #> create mode 100644 assets/fonts/Mulish-Regular.woff2 #> create mode 100644 assets/fonts/Mulish-SemiBold.eot #> create mode 100644 assets/fonts/Mulish-SemiBold.svg #> create mode 100644 assets/fonts/Mulish-SemiBold.ttf #> create mode 100644 assets/fonts/Mulish-SemiBold.woff #> create mode 100644 assets/fonts/Mulish-SemiBold.woff2 #> create mode 100644 assets/fonts/Mulish-SemiBoldItalic.eot #> create mode 100644 assets/fonts/Mulish-SemiBoldItalic.svg #> create mode 100644 assets/fonts/Mulish-SemiBoldItalic.ttf #> create mode 100644 assets/fonts/Mulish-SemiBoldItalic.woff #> create mode 100644 assets/fonts/Mulish-SemiBoldItalic.woff2 #> create mode 100644 assets/fonts/Mulish-VariableFont_wght.ttf #> create mode 100644 assets/fonts/MulishExtraLight-Regular.eot #> create mode 100644 assets/fonts/MulishExtraLight-Regular.svg #> create mode 100644 assets/fonts/MulishExtraLight-Regular.woff #> create mode 100644 assets/fonts/MulishExtraLight-Regular.woff2 #> create mode 100644 assets/fonts/mulish-v5-latin-regular.eot #> create mode 100644 assets/fonts/mulish-v5-latin-regular.svg #> create mode 100644 assets/fonts/mulish-v5-latin-regular.ttf #> create mode 100644 assets/fonts/mulish-v5-latin-regular.woff #> create mode 100644 assets/fonts/mulish-v5-latin-regular.woff2 #> create mode 100644 assets/fonts/mulish-variablefont_wght.woff #> create mode 100644 assets/fonts/mulish-variablefont_wght.woff2 #> create mode 100644 assets/images/carpentries-logo-sm.svg #> create mode 100644 assets/images/carpentries-logo.svg #> create mode 100644 assets/images/data-logo-sm.svg #> create mode 100644 assets/images/data-logo.svg #> create mode 100644 assets/images/dropdown-arrow.svg #> create mode 100644 assets/images/incubator-logo-sm.svg #> create mode 100644 assets/images/incubator-logo.svg #> create mode 100644 assets/images/lab-logo-sm.svg #> create mode 100644 assets/images/lab-logo.svg #> create mode 100644 assets/images/library-logo-sm.svg #> create mode 100644 assets/images/library-logo.svg #> create mode 100644 assets/images/minus.svg #> create mode 100644 assets/images/plus.svg #> create mode 100644 assets/images/software-logo-sm.svg #> create mode 100644 assets/images/software-logo.svg #> create mode 100644 assets/scripts.js #> create mode 100644 assets/styles.css #> create mode 100644 assets/styles.css.map #> create mode 100644 assets/themetoggle.js #> create mode 100644 bootstrap-toc.css #> create mode 100644 bootstrap-toc.js #> create mode 100644 config.yaml #> create mode 100644 docsearch.css #> create mode 100644 docsearch.js #> create mode 100644 favicon-16x16.png #> create mode 100644 favicon-32x32.png #> create mode 100644 favicons/cp/apple-touch-icon-114x114.png #> create mode 100644 favicons/cp/apple-touch-icon-120x120.png #> create mode 100644 favicons/cp/apple-touch-icon-144x144.png #> create mode 100644 favicons/cp/apple-touch-icon-152x152.png #> create mode 100644 favicons/cp/apple-touch-icon-57x57.png #> create mode 100644 favicons/cp/apple-touch-icon-60x60.png #> create mode 100644 favicons/cp/apple-touch-icon-72x72.png #> create mode 100644 favicons/cp/apple-touch-icon-76x76.png #> create mode 100644 favicons/cp/favicon-128.png #> create mode 100644 favicons/cp/favicon-16x16.png #> create mode 100644 favicons/cp/favicon-196x196.png #> create mode 100644 favicons/cp/favicon-32x32.png #> create mode 100644 favicons/cp/favicon-96x96.png #> create mode 100644 favicons/cp/favicon.ico #> create mode 100644 favicons/cp/mstile-144x144.png #> create mode 100644 favicons/cp/mstile-150x150.png #> create mode 100644 favicons/cp/mstile-310x150.png #> create mode 100644 favicons/cp/mstile-310x310.png #> create mode 100644 favicons/cp/mstile-70x70.png #> create mode 100644 favicons/dc/apple-touch-icon-114x114.png #> create mode 100644 favicons/dc/apple-touch-icon-120x120.png #> create mode 100644 favicons/dc/apple-touch-icon-144x144.png #> create mode 100644 favicons/dc/apple-touch-icon-152x152.png #> create mode 100644 favicons/dc/apple-touch-icon-57x57.png #> create mode 100644 favicons/dc/apple-touch-icon-60x60.png #> create mode 100644 favicons/dc/apple-touch-icon-72x72.png #> create mode 100644 favicons/dc/apple-touch-icon-76x76.png #> create mode 100644 favicons/dc/favicon-128.png #> create mode 100644 favicons/dc/favicon-16x16.png #> create mode 100644 favicons/dc/favicon-196x196.png #> create mode 100644 favicons/dc/favicon-32x32.png #> create mode 100644 favicons/dc/favicon-96x96.png #> create mode 100644 favicons/dc/favicon.ico #> create mode 100644 favicons/dc/mstile-144x144.png #> create mode 100644 favicons/dc/mstile-150x150.png #> create mode 100644 favicons/dc/mstile-310x150.png #> create mode 100644 favicons/dc/mstile-310x310.png #> create mode 100644 favicons/dc/mstile-70x70.png #> create mode 100644 favicons/lc/apple-touch-icon-114x114.png #> create mode 100644 favicons/lc/apple-touch-icon-120x120.png #> create mode 100644 favicons/lc/apple-touch-icon-144x144.png #> create mode 100644 favicons/lc/apple-touch-icon-152x152.png #> create mode 100644 favicons/lc/apple-touch-icon-57x57.png #> create mode 100644 favicons/lc/apple-touch-icon-60x60.png #> create mode 100644 favicons/lc/apple-touch-icon-72x72.png #> create mode 100644 favicons/lc/apple-touch-icon-76x76.png #> create mode 100644 favicons/lc/favicon-128.png #> create mode 100644 favicons/lc/favicon-16x16.png #> create mode 100644 favicons/lc/favicon-196x196.png #> create mode 100644 favicons/lc/favicon-32x32.png #> create mode 100644 favicons/lc/favicon-96x96.png #> create mode 100644 favicons/lc/favicon.ico #> create mode 100644 favicons/lc/mstile-144x144.png #> create mode 100644 favicons/lc/mstile-150x150.png #> create mode 100644 favicons/lc/mstile-310x150.png #> create mode 100644 favicons/lc/mstile-310x310.png #> create mode 100644 favicons/lc/mstile-70x70.png #> create mode 100644 favicons/swc/apple-touch-icon-114x114.png #> create mode 100644 favicons/swc/apple-touch-icon-120x120.png #> create mode 100644 favicons/swc/apple-touch-icon-144x144.png #> create mode 100644 favicons/swc/apple-touch-icon-152x152.png #> create mode 100644 favicons/swc/apple-touch-icon-57x57.png #> create mode 100644 favicons/swc/apple-touch-icon-60x60.png #> create mode 100644 favicons/swc/apple-touch-icon-72x72.png #> create mode 100644 favicons/swc/apple-touch-icon-76x76.png #> create mode 100644 favicons/swc/favicon-128.png #> create mode 100644 favicons/swc/favicon-16x16.png #> create mode 100644 favicons/swc/favicon-196x196.png #> create mode 100644 favicons/swc/favicon-32x32.png #> create mode 100644 favicons/swc/favicon-96x96.png #> create mode 100644 favicons/swc/favicon.ico #> create mode 100644 favicons/swc/mstile-144x144.png #> create mode 100644 favicons/swc/mstile-150x150.png #> create mode 100644 favicons/swc/mstile-310x150.png #> create mode 100644 favicons/swc/mstile-310x310.png #> create mode 100644 favicons/swc/mstile-70x70.png #> create mode 100644 fig/introduction-rendered-pyramid-1.png #> create mode 100644 images.html #> create mode 100644 index.html #> create mode 100644 instructor-notes.html #> create mode 100644 instructor/404.html #> create mode 100644 instructor/CODE_OF_CONDUCT.html #> create mode 100644 instructor/LICENSE.html #> create mode 100644 instructor/aio.html #> create mode 100644 instructor/images.html #> create mode 100644 instructor/index.html #> create mode 100644 instructor/instructor-notes.html #> create mode 100644 instructor/introduction.html #> create mode 100644 instructor/key-points.html #> create mode 100644 instructor/profiles.html #> create mode 100644 instructor/reference.html #> create mode 100644 introduction.html #> create mode 100644 key-points.html #> create mode 100644 link.svg #> create mode 100644 md5sum.txt #> create mode 100644 mstile-150x150.png #> create mode 100644 pkgdown.css #> create mode 100644 pkgdown.js #> create mode 100644 pkgdown.yml #> create mode 100644 profiles.html #> create mode 100644 reference.html #> create mode 100644 renv.lock #> create mode 100644 safari-pinned-tab.svg #> create mode 100644 site.webmanifest #> create mode 100644 sitemap.xml #> Running git remote -v #> sandpaper-local\t/tmp/RtmpQSXDNq/REMOTE-17062f1ff59f (fetch) #> sandpaper-local\t/tmp/RtmpQSXDNq/REMOTE-17062f1ff59f (push) #> Running git push --force sandpaper-local 'HEAD:gh-pages' #> To /tmp/RtmpQSXDNq/REMOTE-17062f1ff59f #> 344b40d..eedb7fc HEAD -> gh-pages #> ::endgroup:: #> Running git worktree remove --force \\ #> /tmp/RtmpQSXDNq/file17065ef9650b/lesson-example/site/docs #> Running git worktree remove --force \\ #> /tmp/RtmpQSXDNq/file17065ef9650b/lesson-example/site/built tok <- Sys.time() cli::cli_alert_info(\"Elapsed time: {round(tok - tik, 2)} seconds\") #> ℹ Elapsed time: 13.95 seconds # reporting ----- # The repository and remote should both have three branches cli::cli_h2(\"Local status\") #> #> ── Local status ── #> gert::git_branch_list(repo = res)[c('name', 'commit', 'updated')] #> # A tibble: 6 × 3 #> name commit updated #> <chr> <chr> <dttm> #> 1 gh-pages eedb7fc4c87cc8870a264a… 2024-11-07 18:54:53 #> 2 main 22a7c95023db2822803f58… 2024-11-07 18:54:40 #> 3 md-outputs bf6815545b4377ff7c8711… 2024-11-07 18:54:43 #> 4 sandpaper-local/gh-pages eedb7fc4c87cc8870a264a… 2024-11-07 18:54:53 #> 5 sandpaper-local/main 22a7c95023db2822803f58… 2024-11-07 18:54:40 #> 6 sandpaper-local/md-outputs bf6815545b4377ff7c8711… 2024-11-07 18:54:43 # An indicator this worked: the first episode should be represented as # different files across the branches: # - main: Rmd # - md-outputs: md # - gh-pages: html cli::cli_h2(\"First episode status\") #> ── First episode status ── #> gert::git_stat_files(\"episodes/introduction.Rmd\", repo = rmt) #> # A tibble: 1 × 5 #> file created modified commits head #> * <chr> <dttm> <dttm> <int> <chr> #> 1 episodes/introd… 2024-11-07 18:54:40 2024-11-07 18:54:40 1 22a7… cli::cli_h3(\"rendered markdown\") #> ── rendered markdown gert::git_stat_files(\"introduction.md\", repo = rmt, ref = \"md-outputs\") #> # A tibble: 1 × 5 #> file created modified commits head #> * <chr> <dttm> <dttm> <int> <chr> #> 1 introduction.md 2024-11-07 18:54:43 2024-11-07 18:54:43 1 bf681… cli::cli_h3(\"html file\") #> #> ── html file gert::git_stat_files(\"introduction.html\", repo = rmt, ref = \"gh-pages\") #> # A tibble: 1 × 5 #> file created modified commits head #> * <chr> <dttm> <dttm> <int> <chr> #> 1 introduction.ht… 2024-11-07 18:54:53 2024-11-07 18:54:53 1 eedb… # CLEAN ------------------------------------------------------------------- tik <- Sys.time() cli::cli_h1(\"Clean Up\") #> #> ── Clean Up ──────────────────────────────────────────────────────────── snd$remove_local_remote(repo = res) #> ℹ removing 'sandpaper-local' (/tmp/RtmpQSXDNq/REMOTE-17062f1ff59f) #> /tmp/RtmpQSXDNq/REMOTE-17062f1ff59f snd$reset_git_user(res) # remove the test fixture and report tryCatch(fs::dir_delete(res), error = function() FALSE) tok <- Sys.time() cli::cli_alert_info(\"Elapsed time: {round(tok - tik, 2)} seconds\") #> ℹ Elapsed time: 0.11 seconds"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_session_info.html","id":null,"dir":"Reference","previous_headings":"","what":"Report session information to the user — ci_session_info","title":"Report session information to the user — ci_session_info","text":"function used continuous integration report packages used building site pull requests","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_session_info.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Report session information to the user — ci_session_info","text":"","code":"ci_session_info()"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/ci_session_info.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Report session information to the user — ci_session_info","text":"Nothing, used entirely side-effect","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/copy_template.html","id":null,"dir":"Reference","previous_headings":"","what":"copy a sandpaper template file to a path with data — copy_template","title":"copy a sandpaper template file to a path with data — copy_template","text":"copy sandpaper template file path data","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/copy_template.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"copy a sandpaper template file to a path with data — copy_template","text":"","code":"copy_template(template, path = NULL, name = NULL, values = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/copy_template.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"copy a sandpaper template file to a path with data — copy_template","text":"template base valid template function (e.g. \"episode\" template_episode()) path folder write file. Defaults NULL, return filled template character vector name name file. Defaults NULL values values fill template (). Consult files templates/ folder sandpaper installation details.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/copy_template.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"copy a sandpaper template file to a path with data — copy_template","text":"character vector path name NULL, otherwise, used side effect creating file.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_episode.html","id":null,"dir":"Reference","previous_headings":"","what":"Create an Episode from a template — create_episode","title":"Create an Episode from a template — create_episode","text":"functions allow create episode added schedule.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_episode.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create an Episode from a template — create_episode","text":"","code":"create_episode( title, ext = \"Rmd\", make_prefix = FALSE, add = TRUE, path = \".\", open = rlang::is_interactive() ) create_episode_md( title, make_prefix = FALSE, add = TRUE, path = \".\", open = rlang::is_interactive() ) create_episode_rmd( title, make_prefix = FALSE, add = TRUE, path = \".\", open = rlang::is_interactive() ) draft_episode_md( title, make_prefix = FALSE, path = \".\", open = rlang::is_interactive() ) draft_episode_rmd( title, make_prefix = FALSE, path = \".\", open = rlang::is_interactive() )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_episode.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create an Episode from a template — create_episode","text":"title title episode ext character. ext = \"Rmd\" (default), new episode R Markdown episode. ext = \"md\", new episode markdown episode, can generate dynamic content. make_prefix logical. TRUE, prefix file automatically determined files already present. FALSE (default), assumes prefix needed. add (logical numeric) numeric, represents position episode added. TRUE, episode added end schedule. FALSE, episode added draft episode. path path {sandpaper} lesson. open interactive, episode open new editor window.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_episode.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create an Episode from a template — create_episode","text":"","code":"tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae... #> ☐ Edit /tmp/RtmpQSXDNq/file17061f452ae/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae... #> ✔ First episode created in /tmp/RtmpQSXDNq/file17061f452ae/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae... #> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file17061f452ae #> → Creating Lesson in /tmp/RtmpQSXDNq/file17061f452ae... #> /tmp/RtmpQSXDNq/file17061f452ae create_episode_md(\"getting-started\", path = tmp) #> ☐ Edit /tmp/RtmpQSXDNq/file17061f452ae/episodes/getting-started.md. #> /tmp/RtmpQSXDNq/file17061f452ae/episodes/getting-started.md"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_lesson.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a carpentries lesson — create_lesson","title":"Create a carpentries lesson — create_lesson","text":"create boilerplate directory structure Carpentries lesson initialize git repository.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_lesson.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a carpentries lesson — create_lesson","text":"","code":"create_lesson( path, name = fs::path_file(path), rmd = TRUE, rstudio = rstudioapi::isAvailable(), open = rlang::is_interactive() )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_lesson.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a carpentries lesson — create_lesson","text":"path path new lesson folder name name lesson. provided, folder name used. rmd logical indicator lesson use R Markdown (TRUE, default), use Markdown (FALSE). Note lessons can converted use R Markdown time adding file .Rmd file extension lesson. rstudio create RStudio project (defaults RStudio exits) open interactive, lesson open new editor window.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_lesson.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a carpentries lesson — create_lesson","text":"path new lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_lesson.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a carpentries lesson — create_lesson","text":"","code":"tmp <- tempfile() on.exit(unlink(tmp)) lsn <- create_lesson(tmp, name = \"This Lesson\", open = FALSE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file17067d80f398... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17067d80f398... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17067d80f398... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpQSXDNq/file17067d80f398... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file17067d80f398... #> ☐ Edit /tmp/RtmpQSXDNq/file17067d80f398/episodes/introduction.Rmd. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17067d80f398... #> ✔ First episode created in /tmp/RtmpQSXDNq/file17067d80f398/episodes/introduction.Rmd #> → Creating Lesson in /tmp/RtmpQSXDNq/file17067d80f398... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpQSXDNq/file17067d80f398... #> ℹ Consent to use package cache provided #> → Creating Lesson in /tmp/RtmpQSXDNq/file17067d80f398... #> - The project is out-of-sync -- use `renv::status()` for details. #> → Searching for and installing available dependencies #> The following packages were discovered: #> #> # ~/work/_temp/Library ------------------------------------------------------- #> - R6 2.5.1 #> - base64enc 0.1-3 #> - bslib 0.8.0 #> - cachem 1.1.0 #> - cli 3.6.3 #> - digest 0.6.37 #> - evaluate 1.0.1 #> - fastmap 1.2.0 #> - fontawesome 0.5.2 #> - fs 1.6.5 #> - glue 1.8.0 #> - highr 0.11 #> - htmltools 0.5.8.1 #> - jquerylib 0.1.4 #> - jsonlite 1.8.9 #> - knitr 1.48 #> - lifecycle 1.0.4 #> - memoise 2.0.1 #> - mime 0.12 #> - rappdirs 0.3.3 #> - rlang 1.1.4 #> - rmarkdown 2.29 #> - sass 0.4.9 #> - tinytex 0.54 #> - xfun 0.49 #> - yaml 2.3.10 #> #> They will be copied into the project library. #> #> - Copying packages into the project library ... Done! #> - Hydrated 26 packages in 0.22 seconds. #> - The project is out-of-sync -- use `renv::status()` for details. #> → Recording changes in lockfile #> The following package(s) will be updated in the lockfile: #> #> # https://packagemanager.posit.co/cran/__linux__/jammy/latest ---------------- #> - R6 [* -> 2.5.1] #> - base64enc [* -> 0.1-3] #> - bslib [* -> 0.8.0] #> - cachem [* -> 1.1.0] #> - cli [* -> 3.6.3] #> - digest [* -> 0.6.37] #> - evaluate [* -> 1.0.1] #> - fastmap [* -> 1.2.0] #> - fontawesome [* -> 0.5.2] #> - fs [* -> 1.6.5] #> - glue [* -> 1.8.0] #> - highr [* -> 0.11] #> - htmltools [* -> 0.5.8.1] #> - jquerylib [* -> 0.1.4] #> - jsonlite [* -> 1.8.9] #> - knitr [* -> 1.48] #> - lifecycle [* -> 1.0.4] #> - memoise [* -> 2.0.1] #> - mime [* -> 0.12] #> - rappdirs [* -> 0.3.3] #> - renv [* -> 1.0.11] #> - rlang [* -> 1.1.4] #> - rmarkdown [* -> 2.29] #> - sass [* -> 0.4.9] #> - tinytex [* -> 0.54] #> - xfun [* -> 0.49] #> - yaml [* -> 2.3.10] #> #> The version of R recorded in the lockfile will be updated: #> - R [* -> 4.4.2] #> #> - Lockfile written to \"/tmp/RtmpQSXDNq/file17067d80f398/renv/profiles/lesson-requirements/renv.lock\". #> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file17067d80f398 #> → Creating Lesson in /tmp/RtmpQSXDNq/file17067d80f398... lsn #> /tmp/RtmpQSXDNq/file17067d80f398"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar.html","id":null,"dir":"Reference","previous_headings":"","what":"Create the sidebar for varnish — create_resources_dropdown","title":"Create the sidebar for varnish — create_resources_dropdown","text":"Varnish uses sidebar navigation across within episode. episode's sidebar different needs clear indicator episode current one within sidebar.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create the sidebar for varnish — create_resources_dropdown","text":"","code":"create_resources_dropdown(files, type = \"learners\") create_sidebar( chapters, name = \"\", html = \"<a href='https://carpentries.org'/>\" ) update_sidebar( sidebar = NULL, nodes = NULL, this_page = NULL, title = NULL, item = NULL )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create the sidebar for varnish — create_resources_dropdown","text":"files vector markdown file names type one \"learners\" (default) \"instructors\". learners, setup page excluded since included index. \"instructors\", instructor notes included learner profiles included. chapters character vector paths markdown chapters name name current chapter html html current chapter. defaults link produce sidebar links headings. sidebar object class \"list-store\" \"sidebar\" element stored list. See set_globals(). nodes HTML nodes HTML page this_page path current HTML page title current title item index sidebar item update","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create the sidebar for varnish — create_resources_dropdown","text":"character vector HTML divs can appended display sidebar.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create the sidebar for varnish — create_resources_dropdown","text":"function creates sidebar.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a single item that appears in the sidebar — create_sidebar_item","title":"Create a single item that appears in the sidebar — create_sidebar_item","text":"Varnish uses sidebar navigation across within episode. funciton create sidebar item single episode, providing dropdown menu sections within episode labeled current episode.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a single item that appears in the sidebar — create_sidebar_item","text":"","code":"create_sidebar_item(nodes, link, position) create_sidebar_headings(nodes)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a single item that appears in the sidebar — create_sidebar_item","text":"nodes html nodes webpage generated render_html() parsed xml2 level 2 section headings class section-heading link character vector length 1 defines HTML links used node sidebar item. position either number \"current\", \"current\", html parsed second level headings list sidebar navigation.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar_item.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a single item that appears in the sidebar — create_sidebar_item","text":"character vector div item insert sidebar navigation","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/create_sidebar_item.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a single item that appears in the sidebar — create_sidebar_item","text":"","code":"snd <- asNamespace(\"sandpaper\") html <- c( \"<section id='one'><h2 class='section-heading'>Section 1<\/h2><p>section 1<\/p><\/section>\", \"<section id='two'><h2 class='section-heading'>Section 2<\/h2><p>section 2<\/p><\/section>\" ) nodes <- xml2::read_html(paste(html, collapse = \"\\n\")) # The sidebar headings are extracted from the nodes writeLines(snd$create_sidebar_headings(nodes)) #> <li><a href='#one'>Section 1<\/a><\/li> #> <li><a href='#two'>Section 2<\/a><\/li> link <- \"<a href='https://example.com/this-page.html'><em>This Page<\/em><\/a>\" # the sidebar item will contain the headings if it is the current chapter writeLines(snd$create_sidebar_item(nodes, link, position = \"current\")) #> <div class=\"accordion accordion-flush\" id=\"accordionFlushcurrent\"> #> <div class=\"accordion-item\"> #> <div class=\"accordion-header\" id=\"flush-headingcurrent\"> #> <button class=\"accordion-button\" type=\"button\" data-bs-toggle=\"collapse\" data-bs-target=\"#flush-collapsecurrent\" aria-expanded=\"true\" aria-controls=\"flush-collapsecurrent\"> #> <span class=\"visually-hidden\">Current Chapter<\/span> #> <span class=\"current-chapter\"> #> <a href='https://example.com/this-page.html'><em>This Page<\/em><\/a> #> <\/span> #> <\/button> #> <\/div><!--/div.accordion-header--> #> #> <div id=\"flush-collapsecurrent\" class=\"accordion-collapse collapse show\" aria-labelledby=\"flush-headingcurrent\" data-bs-parent=\"#accordionFlushcurrent\"> #> <div class=\"accordion-body\"> #> <ul> #> <li><a href='#one'>Section 1<\/a><\/li> #> <li><a href='#two'>Section 2<\/a><\/li> #> <\/ul> #> <\/div><!--/div.accordion-body--> #> <\/div><!--/div.accordion-collapse--> #> #> <\/div><!--/div.accordion-item--> #> <\/div><!--/div.accordion-flush--> #> # it will be an ordinary link otherwise writeLines(snd$create_sidebar_item(nodes, link, position = 3)) #> <div class=\"accordion accordion-flush\" id=\"accordionFlush3\"> #> <div class=\"accordion-item\"> #> <div class=\"accordion-header\" id=\"flush-heading3\"> #> <a href='https://example.com/this-page.html'><em>This Page<\/em><\/a> #> <\/div><!--/div.accordion-header--> #> #> <\/div><!--/div.accordion-item--> #> <\/div><!--/div.accordion-flush--> #>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dependency_management.html","id":null,"dir":"Reference","previous_headings":"","what":"Lesson Runtime Dependency Management — manage_deps","title":"Lesson Runtime Dependency Management — manage_deps","text":"customized provisioner Carpentries Lessons based renv install maintain requirements lesson respecting user environments. setup leads several advantages: reliable setup: version lesson built carpentries website build computer packages identical environmentally friendly: lesson dependencies stored default R library alter R environment. transparent: additions deletions cache recorded lockfile, tracked git. functions control cache following: manage_deps(): Creates updates dependencies lesson. lockfile exists lesson, create one . update_cache(): fetches updates dependencies applies cache lockfile. wrapper around renv::record(), helps record package set packages lockfile. can useful want upgrade downgrade specific package.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dependency_management.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Lesson Runtime Dependency Management — manage_deps","text":"","code":"manage_deps( path = \".\", profile = \"lesson-requirements\", snapshot = TRUE, quiet = FALSE ) update_cache( path = \".\", profile = \"lesson-requirements\", prompt = interactive(), quiet = !prompt, snapshot = TRUE ) pin_version(records = NULL, profile = \"lesson-requirements\", path = \".\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dependency_management.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Lesson Runtime Dependency Management — manage_deps","text":"path path lesson. Defaults current working directory. profile default profile lesson. Defaults lesson-requirements. use know . snapshot TRUE, packages cache added lockfile (default). Setting FALSE add packages cache snapshot . quiet TRUE, output suppressed, defaults FALSE, providing output different steps process updating local dependencies. prompt TRUE, message show packages updated lockfile ask permission. default running interactive session. records character vector list packages/resources include lockfile. common way use [package]@[version] syntax (e.g. gert@0.1.3), specifications can specify remote repository. See renv::record() details.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dependency_management.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Lesson Runtime Dependency Management — manage_deps","text":"snapshot = TRUE, nested list representing lockfile returned. contents lockfile, invisibly","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dependency_management.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Lesson Runtime Dependency Management — manage_deps","text":"renv package provides useful interface bring one aspect reproducibility R projects. people working Carpentries lessons also working academics likely projects computer package versions necessary work, important environments respected. flavor {renv} applies package cache explicitly content lesson, impose default {renv} environment. provisioner following steps: check consent use package cache via use_package_cache() prompt needed check profile created create needed via renv::init() populate cache packages needed user's system download missing via renv::hydrate(). includes new packages added lesson. lockfile already present, make sure packages cache aligned lockfile (downloading sources needed) via renv::restore(). Record state cache lockfile tracked git. include adding new packages removing old packages. renv::snapshot() lockfile changes, see git power either commit restore changes.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dot-lesson_store.html","id":null,"dir":"Reference","previous_headings":"","what":"Internal Global Lesson Storage Generator — .lesson_store","title":"Internal Global Lesson Storage Generator — .lesson_store","text":"function generate object store contain update lesson object based status git repository","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dot-lesson_store.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Internal Global Lesson Storage Generator — .lesson_store","text":"","code":".lesson_store()"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dot-lesson_store.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Internal Global Lesson Storage Generator — .lesson_store","text":"list four functions operate supplied path string get() returns .this_lesson (described this_lesson()) set(path) sets .this_lesson git statuses lesson path. also sets set_globals() set_resource_list(). valid(path) uses path validate lesson identical stored lesson git status. Returns TRUE identical FALSE clear() resets global variables.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dot-list_store.html","id":null,"dir":"Reference","previous_headings":"","what":"List Storage Generator — .list_store","title":"List Storage Generator — .list_store","text":"function generate object can serve persistant storage pre-computed values. object contains list called .this_list embedded within enviroment created .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dot-list_store.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List Storage Generator — .list_store","text":"","code":".list_store()"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dot-list_store.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List Storage Generator — .list_store","text":"list five functions operate internal .this_list list object: get() returns value .this_list update(value) updates .this_list modified list value. Useful adding several pieces information . set(key, value) sets given key (vector, element representing level nesting) particular value (can vector list). key NULL, .this_list replaced value clear() sets .this_list NULL copy() creates independent copy object modification.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/dot-list_store.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List Storage Generator — .list_store","text":"","code":"if (FALSE) { # note: asNamespace() gives access to internal functions. This is for # demonstration purposes only. There is no guarantee for these functions to # work. global_list <- asNamespace(\"sandpaper\")$.list_store() global_list$set(key = NULL, list(a = 1, b = list(2))) global_list$set(key = \"c\", \"three\") global_list$get() global_list$update(list(c = \"THREE\", d = global_list$get())) global_list$get() }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fill_translation_vars.html","id":null,"dir":"Reference","previous_headings":"","what":"Apply template items to translated strings — fill_translation_vars","title":"Apply template items to translated strings — fill_translation_vars","text":"Apply template items translated strings","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fill_translation_vars.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Apply template items to translated strings — fill_translation_vars","text":"","code":"fill_translation_vars(the_data)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fill_translation_vars.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Apply template items to translated strings — fill_translation_vars","text":"the_data list global variables (either learner_globals instructor_globals) also contains \"translate\" element containing list translated strings.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fill_translation_vars.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Apply template items to translated strings — fill_translation_vars","text":"translated list templated data filled ","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fill_translation_vars.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Apply template items to translated strings — fill_translation_vars","text":"two kinds templating use: variable templating indicated {key} key represents variable exists within global data replaced. link templating indicated <(text wrap)> replace <()> known URL HTML markup. allows translators translate text without worry HTML markup.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fill_translation_vars.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Apply template items to translated strings — fill_translation_vars","text":"","code":"dat <- list( a = \"a barn\", b = \"a bee\", minutes = 5, translate = list( one = \"a normal translated string (pretend it's translated from another language)\", two = \"a question: are you (A) {a}, (B) {b}\", EstimatedTime = \"Estimated time: {icons$clock} {minutes}\", license = \"Licensed under {license} by the authors\", ThisLessonCoC = \"This lesson operates under our <(Code of Conduct)>\" ) ) asNamespace(\"sandpaper\")$fill_translation_vars(dat) #> $one #> [1] \"a normal translated string (pretend it's translated from another language)\" #> #> $two #> a question: are you (A) a barn, (B) a bee #> #> $EstimatedTime #> Estimated time: <i aria-hidden=\"true\" data-feather=\"clock\"><\/i> 5 #> #> $license #> Licensed under <a href=\"LICENSE.html\">CC-BY 4.0<\/a> by the authors #> #> $ThisLessonCoC #> [1] \"This lesson operates under our <a href=\\\"CODE_OF_CONDUCT.html\\\">Code of Conduct<\/a>\" #>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fix_sidebar_href.html","id":null,"dir":"Reference","previous_headings":"","what":"Fix the refs for a vector of sidebar nodes — fix_sidebar_href","title":"Fix the refs for a vector of sidebar nodes — fix_sidebar_href","text":"update links list HTML node","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fix_sidebar_href.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fix the refs for a vector of sidebar nodes — fix_sidebar_href","text":"","code":"fix_sidebar_href( item, path = NULL, scheme = NULL, server = NULL, query = NULL, fragment = NULL ) make_url(parsed) append(first, sep = \"#\", last, trim = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fix_sidebar_href.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fix the refs for a vector of sidebar nodes — fix_sidebar_href","text":"item text representation HTML nodes contain <> elements. path, scheme, server, query, fragment character vectors elements replace. can single element vector, recycled vector length item. parsed data frame produced via xml2::url_parse first character vector sep character vector length 1 last character vector, length first length 1 trim logical indicating leading trailing sep trimmed first last.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fix_sidebar_href.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fix the refs for a vector of sidebar nodes — fix_sidebar_href","text":"text representation HTML nodes href element modified.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fix_sidebar_href.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Fix the refs for a vector of sidebar nodes — fix_sidebar_href","text":"Repeat : parsing HTML regular expressions bad. function uses xml2::read_html() parse incoming HTML content convert HTML string XML document can extract anchor links, parse replace contents without regex. acheived via xml2::url_parse() separating URL pieces updating pieces node. fix_sidebar_href() useful sidebar nodes needs updated 404 page links use published URL. NOTE: take account port user. auxilary functions make_url(), append() prepend() used convert output xml2::url_parse() back URL.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fix_sidebar_href.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fix the refs for a vector of sidebar nodes — fix_sidebar_href","text":"","code":"my_links <- c( \"<div id='one'><div id='one-one'><a href='index.html'>Index<\/a><\/div><\/div>\", \"<div id='two'><div id='two-two'><a href='two.html'><em>Two<\/em><\/a><\/div><\/div>\", \"<div id='three'><div id='three-three'><a href='three.html'>Three<\/a><\/div><\/div>\", \"<div id='four'><div id='four-four'><a href='four.html'>Four<\/a><\/div><\/div>\", \"<div id='five'><div id='five-five'><a href='five.html'>Five<\/a><\/div><\/div>\" ) snd <- asNamespace(\"sandpaper\") # Prepend a server to the links snd$fix_sidebar_href(my_links, scheme = \"https\", server = \"example.com\") #> [1] \"<div id=\\\"one\\\"><div id=\\\"one-one\\\"><a href=\\\"https://example.com/index.html\\\">Index<\/a><\/div><\/div>\" #> [2] \"<div id=\\\"two\\\"><div id=\\\"two-two\\\"><a href=\\\"https://example.com/two.html\\\"><em>Two<\/em><\/a><\/div><\/div>\" #> [3] \"<div id=\\\"three\\\"><div id=\\\"three-three\\\"><a href=\\\"https://example.com/three.html\\\">Three<\/a><\/div><\/div>\" #> [4] \"<div id=\\\"four\\\"><div id=\\\"four-four\\\"><a href=\\\"https://example.com/four.html\\\">Four<\/a><\/div><\/div>\" #> [5] \"<div id=\\\"five\\\"><div id=\\\"five-five\\\"><a href=\\\"https://example.com/five.html\\\">Five<\/a><\/div><\/div>\" snd$fix_sidebar_href(my_links, server = \"https://example.com\") #> [1] \"<div id=\\\"one\\\"><div id=\\\"one-one\\\"><a href=\\\"https://example.com/index.html\\\">Index<\/a><\/div><\/div>\" #> [2] \"<div id=\\\"two\\\"><div id=\\\"two-two\\\"><a href=\\\"https://example.com/two.html\\\"><em>Two<\/em><\/a><\/div><\/div>\" #> [3] \"<div id=\\\"three\\\"><div id=\\\"three-three\\\"><a href=\\\"https://example.com/three.html\\\">Three<\/a><\/div><\/div>\" #> [4] \"<div id=\\\"four\\\"><div id=\\\"four-four\\\"><a href=\\\"https://example.com/four.html\\\">Four<\/a><\/div><\/div>\" #> [5] \"<div id=\\\"five\\\"><div id=\\\"five-five\\\"><a href=\\\"https://example.com/five.html\\\">Five<\/a><\/div><\/div>\" # Add an anchor to the links snd$fix_sidebar_href(my_links, scheme = \"https\", fragment = \"anchor\") #> [1] \"<div id=\\\"one\\\"><div id=\\\"one-one\\\"><a href=\\\"https://index.html#anchor\\\">Index<\/a><\/div><\/div>\" #> [2] \"<div id=\\\"two\\\"><div id=\\\"two-two\\\"><a href=\\\"https://two.html#anchor\\\"><em>Two<\/em><\/a><\/div><\/div>\" #> [3] \"<div id=\\\"three\\\"><div id=\\\"three-three\\\"><a href=\\\"https://three.html#anchor\\\">Three<\/a><\/div><\/div>\" #> [4] \"<div id=\\\"four\\\"><div id=\\\"four-four\\\"><a href=\\\"https://four.html#anchor\\\">Four<\/a><\/div><\/div>\" #> [5] \"<div id=\\\"five\\\"><div id=\\\"five-five\\\"><a href=\\\"https://five.html#anchor\\\">Five<\/a><\/div><\/div>\" # NOTE: this will _always_ return a character vector, even if the input is # incorrect snd$fix_sidebar_href(list(), server = \"example.com\") #> [1] \"\""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":null,"dir":"Reference","previous_headings":"","what":"Test fixture functions for sandpaper — create_test_lesson","title":"Test fixture functions for sandpaper — create_test_lesson","text":"suite functions use testing {sandpaper} designed create/work temporary lesson associated remote repository (locally) persists throughout test suite. functions used tests/testthat/setup.R. information, see package scope section testthat article Test Fixtures.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Test fixture functions for sandpaper — create_test_lesson","text":"","code":"create_test_lesson() generate_restore_fixture(repo) setup_local_remote( repo, remote = tempfile(), name = \"sandpaper-local\", verbose = FALSE ) make_branch(repo, branch = NULL, name = \"sandpaper-local\", verbose = FALSE) clean_branch(repo, branch = NULL, name = \"sandpaper-local\", verbose = FALSE) remove_local_remote(repo, name = \"sandpaper-local\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Test fixture functions for sandpaper — create_test_lesson","text":"repo path git repository remote path empty uninitialized directory. Defaults tempfile name remote, defaults \"sandpaper-local\" verbose TRUE, messages output git printed screen. Defaults FALSE. branch name new branch deleted","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Test fixture functions for sandpaper — create_test_lesson","text":"(generate_restore_fixture) function restore test fixture (setup_local_remote()) repo, invisibly (remove_local_remote()) FALSE indicating error string indicating path remote","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"create-test-lesson-","dir":"Reference","previous_headings":"","what":"create_test_lesson()","title":"Test fixture functions for sandpaper — create_test_lesson","text":"creates test lesson calls generate_restore_fixture() path new test lesson.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"generate-restore-fixture-","dir":"Reference","previous_headings":"","what":"generate_restore_fixture()","title":"Test fixture functions for sandpaper — create_test_lesson","text":"creates function restore lesson previous commit.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"setup-local-remote-","dir":"Reference","previous_headings":"","what":"setup_local_remote()","title":"Test fixture functions for sandpaper — create_test_lesson","text":"Creates local remote repository separate temporary folder, linked fixture lesson.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"make-branch-","dir":"Reference","previous_headings":"","what":"make_branch()","title":"Test fixture functions for sandpaper — create_test_lesson","text":"create branch local repository push remote repository.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"clean-branch-","dir":"Reference","previous_headings":"","what":"clean_branch()","title":"Test fixture functions for sandpaper — create_test_lesson","text":"delete branch local remote repository.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"remove-local-remote-","dir":"Reference","previous_headings":"","what":"remove_local_remote()","title":"Test fixture functions for sandpaper — create_test_lesson","text":"Destorys local remote repository removes fixture lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/fixtures.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Test fixture functions for sandpaper — create_test_lesson","text":"implemented tests/testthat/setup.md","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_config.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the configuration parameters for the lesson — get_config","title":"Get the configuration parameters for the lesson — get_config","text":"Get configuration parameters lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_config.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the configuration parameters for the lesson — get_config","text":"","code":"get_config(path = \".\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_config.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the configuration parameters for the lesson — get_config","text":"path path lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_config.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the configuration parameters for the lesson — get_config","text":"yaml list","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_config.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get the configuration parameters for the lesson — get_config","text":"","code":"tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file170626db1643... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpQSXDNq/file170626db1643... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpQSXDNq/file170626db1643... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpQSXDNq/file170626db1643... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file170626db1643... #> ☐ Edit /tmp/RtmpQSXDNq/file170626db1643/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpQSXDNq/file170626db1643... #> ✔ First episode created in /tmp/RtmpQSXDNq/file170626db1643/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpQSXDNq/file170626db1643... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpQSXDNq/file170626db1643... #> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file170626db1643 #> → Creating Lesson in /tmp/RtmpQSXDNq/file170626db1643... #> /tmp/RtmpQSXDNq/file170626db1643 get_config(tmp) #> $carpentry #> [1] \"incubator\" #> #> $title #> [1] \"Lesson Title\" #> #> $created #> [1] \"2024-11-07\" #> #> $keywords #> [1] \"software, data, lesson, The Carpentries\" #> #> $life_cycle #> [1] \"pre-alpha\" #> #> $license #> [1] \"CC-BY 4.0\" #> #> $source #> [1] \"https://github.com/carpentries/file170626db1643\" #> #> $branch #> [1] \"main\" #> #> $contact #> [1] \"team@carpentries.org\" #> #> $episodes #> [1] \"introduction.md\" #> #> $learners #> NULL #> #> $instructors #> NULL #> #> $profiles #> NULL #>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_content.html","id":null,"dir":"Reference","previous_headings":"","what":"Get sections from an episode's HTML page — get_content","title":"Get sections from an episode's HTML page — get_content","text":"Get sections episode's HTML page","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_content.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get sections from an episode's HTML page — get_content","text":"","code":"get_content( episode, content = \"*\", label = FALSE, pkg = NULL, instructor = FALSE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_content.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get sections from an episode's HTML page — get_content","text":"episode object class xml_document, path markdown html file episode. content XPath fragment. defaults \"*\" label TRUE, elements named ids. best used content = \"section\". pkg object created via pkgdown::as_pkgdown() lesson. instructor TRUE, instructor version episode read, defaults FALSE. effect episode xml_document.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_content.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get sections from an episode's HTML page — get_content","text":"contents lesson contained following templating cascade: function extract content episode without templating.","code":"<body> <div class='container'> <div class='row'> <div class='[...] primary-content'> <main> <div class='[...] lesson-content'> CONTENT HERE"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_content.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get sections from an episode's HTML page — get_content","text":"","code":"if (FALSE) { lsn <- \"/path/to/lesson\" pkg <- pkgdown::as_pkgdown(fs::path(lsn, \"site\")) # for AiO pages, this will return only the top-level sections: get_content(\"aio\", content = \"section\", label = TRUE, pkg = pkg) # for episode pages, this will return everything that's not template get_content(\"01-introduction\", pkg = pkg) # for things that are within lessons but we don't know their exact location, # we can prefix a `/` to double up the slash, which will produce }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_drafts.html","id":null,"dir":"Reference","previous_headings":"","what":"Show files in draft form — get_drafts","title":"Show files in draft form — get_drafts","text":"default, {sandpaper} use files alphabetical order presented folders, however, strongly authors specify order files lessons, easy rearrange add, split, rearrange files.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_drafts.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Show files in draft form — get_drafts","text":"","code":"get_drafts( path, folder = NULL, message = getOption(\"sandpaper.show_draft\", TRUE) )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_drafts.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Show files in draft form — get_drafts","text":"path path sandpaper lesson folder specific folder list draft files. Defaults NULL, indicates folders listed config.yaml. message TRUE (default), informative message files draft status printed screen.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_drafts.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Show files in draft form — get_drafts","text":"vector paths files draft message (specified)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_drafts.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Show files in draft form — get_drafts","text":"mechanism also allows authors work files draft form without published. function list show files draft automation audit.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_dropdown.html","id":null,"dir":"Reference","previous_headings":"","what":"Helpers to extract contents of dropdown menus on the site — get_dropdown","title":"Helpers to extract contents of dropdown menus on the site — get_dropdown","text":"fuction extract resources exist listed config file.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_dropdown.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helpers to extract contents of dropdown menus on the site — get_dropdown","text":"","code":"get_dropdown(path = \".\", folder, trim = TRUE) get_episodes(path = \".\", trim = TRUE) get_learners(path = \".\", trim = TRUE) get_instructors(path = \".\", trim = TRUE) get_profiles(path = \".\", trim = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_dropdown.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helpers to extract contents of dropdown menus on the site — get_dropdown","text":"path path lesson, defaults current working directory folder folder extract fromt dropdown menues trim TRUE (default), file name presented. FALSE, full path prepended.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_dropdown.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helpers to extract contents of dropdown menus on the site — get_dropdown","text":"character vector episodes order presentation","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_dropdown.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Helpers to extract contents of dropdown menus on the site — get_dropdown","text":"","code":"tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file17064e4661ed... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17064e4661ed... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17064e4661ed... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpQSXDNq/file17064e4661ed... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file17064e4661ed... #> ☐ Edit /tmp/RtmpQSXDNq/file17064e4661ed/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17064e4661ed... #> ✔ First episode created in /tmp/RtmpQSXDNq/file17064e4661ed/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpQSXDNq/file17064e4661ed... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpQSXDNq/file17064e4661ed... #> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file17064e4661ed #> → Creating Lesson in /tmp/RtmpQSXDNq/file17064e4661ed... #> /tmp/RtmpQSXDNq/file17064e4661ed get_episodes(tmp) #> [1] \"introduction.md\" get_learners(tmp) # information for learners #> [1] \"reference.md\" \"setup.md\""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_nav_data.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate the navigation data for a page — get_nav_data","title":"Generate the navigation data for a page — get_nav_data","text":"Generate navigation data page","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_nav_data.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate the navigation data for a page — get_nav_data","text":"","code":"get_nav_data( path_md, path_src = NULL, home = NULL, this_page = NULL, page_back = NULL, page_forward = NULL )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_nav_data.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate the navigation data for a page — get_nav_data","text":"path_md path episode markdown (RMarkdown) file (usually via build_episode_md()). path_src default NULL indicating source file determined sandpaper-source entry yaml header. present, option allows specify file. home path lesson home this_page current page relative html address page_back URL previous page page_forward URL next page","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_resource_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the full resource list of markdown files — get_resource_list","title":"Get the full resource list of markdown files — get_resource_list","text":"Get full resource list markdown files","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_resource_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the full resource list of markdown files — get_resource_list","text":"","code":"get_resource_list(path, trim = FALSE, subfolder = NULL, warn = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_resource_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the full resource list of markdown files — get_resource_list","text":"path path lesson trim TRUE, trim paths relative lesson directory. Defaults FALSE, return absolute paths subfolder subfolder check. NULL, folders checked returned (default), otherwise, string specifying folder name lesson (e.g. \"episodes\"). warn TRUE subfolder = \"episodes\", message issued user episodes field configuration file empty.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_resource_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the full resource list of markdown files — get_resource_list","text":"list files subfolder order appear menu.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_syllabus.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a syllabus for the lesson — get_syllabus","title":"Create a syllabus for the lesson — get_syllabus","text":"function generally internal use, may useful whish automate creation home pages.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_syllabus.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a syllabus for the lesson — get_syllabus","text":"","code":"get_syllabus(path = \".\", questions = FALSE, use_built = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_syllabus.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a syllabus for the lesson — get_syllabus","text":"path path lesson questions TRUE, questions episodes added table. Defaults FALSE. use_built TRUE (default), rendered episodes used generate syllabus","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/get_syllabus.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a syllabus for the lesson — get_syllabus","text":"data frame containing syllabus lesson timing, links, questions associated","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/git_worktree.html","id":null,"dir":"Reference","previous_headings":"","what":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","title":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","text":"Setup git worktree concurrent manipulation separate branch","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/git_worktree.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","text":"","code":"git_worktree_setup( path = \".\", dest_dir, branch = \"gh-pages\", remote = \"origin\", throwaway = FALSE ) github_worktree_commit(dir, commit_message, remote, branch) github_worktree_remove(dir, home = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/git_worktree.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","text":"path path repository dest_dir path destination directory contain work tree branch branch associated work tree (default: gh-pages) remote remote name (default: origin) throwaway TRUE, worktree created detached HEAD state remote branch create new branch repository. Defaults FALSE, create branch upstream.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/git_worktree.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","text":"expression() calls git worktree remove worktree evaluated.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/git_worktree.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","text":"function used continuous integration settings want push derived outputs non-main branches repository. use populate markdown HTML outputs lesson rebuild lesson scratch every time. logic behind looks like","code":"worktree setup [IF BRANCH DOES NOT EXIST] git checkout --orphan <branch> git rm -rf --quiet . git commit --allow-empty -m git push remote HEAD:<branch> git checkout - git fetch <remote> +refs/heads/<branch>:refs/remotes/<remote>/<branch> git worktree add --track -B <branch> /path/to/dir <remote>/<branch>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/git_worktree.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","text":"git_worktree_setup() modified logic pkgdown::deploy_to_branch(), Hadley Wickham. github_worktree_commit(): Modified pkgdown:::github_push Hadley Wickham github_worktree_remove(): Modified pkgdown:::github_worktree_remove Hadley Wickham","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/git_worktree.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Setup a git worktree for concurrent manipulation of a separate branch — git_worktree_setup","text":"","code":"# Use Worktrees to deploy a lesson ----------------------------------------- # This example is a bit inovlved, but it is effectively what we do inside of # the `ci_deploy()` function (after setting up the lesson). # # The setup phase will create a new lesson and a corresponding remote (self # contained, no GitHub authentication required). # # The worktrees will be created for both the markdown and HTML outputs on the # branches \"md-outputs\" and \"gh-pages\", respectively. # # After the worktrees are created, we will build the lesson into the # worktrees and display the output of `git_status()` for each of the three # branches: \"main\", \"md-outputs\", and \"gh-pages\" # # During the clean up phase, the output of `git_worktree_setup()` is # evaluated tik <- Sys.time() cli::cli_h1(\"Set up\") #> #> ── Set up ────────────────────────────────────────────────────────────── cli::cli_h2(\"Create Lesson\") #> #> ── Create Lesson ── #> restore_fixture <- sandpaper:::create_test_lesson() #> → Bootstrapping example lesson #> ℹ Lesson bootstrapped in 3.122818 secs #> → Bootstrapping example lesson res <- getOption(\"sandpaper.test_fixture\") sandpaper:::check_git_user(res) cli::cli_h2(\"Create Remote\") #> #> ── Create Remote ── #> rmt <- fs::file_temp(pattern = \"REMOTE-\") sandpaper:::setup_local_remote(repo = res, remote = rmt, verbose = FALSE) #> ℹ Remote set up in 0.01342487 secs tok <- Sys.time() cli::cli_alert_info(\"Elapsed time: {round(tok - tik, 2)} seconds\") #> ℹ Elapsed time: 3.16 seconds tik <- Sys.time() cli::cli_h2(\"Create Worktrees\") #> #> ── Create Worktrees ── #> db <- sandpaper:::git_worktree_setup(res, fs::path(res, \"site\", \"built\"), branch = \"md-outputs\", remote = \"sandpaper-local\" ) #> ::group::Create New Branch #> Running git checkout --orphan md-outputs #> Switched to a new branch 'md-outputs' #> Running git rm -rf --quiet . #> Running git commit --allow-empty -m 'Initializing md-outputs branch' #> [md-outputs (root-commit) 3236dee] Initializing md-outputs branch #> Running git push sandpaper-local 'HEAD:md-outputs' #> To /tmp/RtmpQSXDNq/REMOTE-17064183ffc5 #> * [new branch] HEAD -> md-outputs #> Running git checkout main #> Switched to branch 'main' #> Your branch is up to date with 'sandpaper-local/main'. #> ::endgroup:: #> ::group::Fetch sandpaper-local/md-outputs #> Running git remote set-branches sandpaper-local md-outputs #> Running git fetch sandpaper-local md-outputs #> From /tmp/RtmpQSXDNq/REMOTE-17064183ffc5 #> * branch md-outputs -> FETCH_HEAD #> Running git remote set-branches sandpaper-local '*' #> ::endgroup:: #> ::group::Add worktree for sandpaper-local/md-outputs in site/built #> Running git worktree add --track -B md-outputs \\ #> /tmp/RtmpQSXDNq/file170634e2fcab/lesson-example/site/built \\ #> sandpaper-local/md-outputs #> Preparing worktree (resetting branch 'md-outputs'; was at 3236dee) #> branch 'md-outputs' set up to track 'sandpaper-local/md-outputs'. #> HEAD is now at 3236dee Initializing md-outputs branch #> ::endgroup:: ds <- sandpaper:::git_worktree_setup(res, fs::path(res, \"site\", \"docs\"), branch = \"gh-pages\", remote = \"sandpaper-local\" ) #> ::group::Create New Branch #> Running git checkout --orphan gh-pages #> Switched to a new branch 'gh-pages' #> Running git rm -rf --quiet . #> Running git commit --allow-empty -m 'Initializing gh-pages branch' #> [gh-pages (root-commit) 12c64a9] Initializing gh-pages branch #> Running git push sandpaper-local 'HEAD:gh-pages' #> To /tmp/RtmpQSXDNq/REMOTE-17064183ffc5 #> * [new branch] HEAD -> gh-pages #> Running git checkout main #> Switched to branch 'main' #> Your branch is up to date with 'sandpaper-local/main'. #> ::endgroup:: #> ::group::Fetch sandpaper-local/gh-pages #> Running git remote set-branches sandpaper-local gh-pages #> Running git fetch sandpaper-local gh-pages #> From /tmp/RtmpQSXDNq/REMOTE-17064183ffc5 #> * branch gh-pages -> FETCH_HEAD #> Running git remote set-branches sandpaper-local '*' #> ::endgroup:: #> ::group::Add worktree for sandpaper-local/gh-pages in site/docs #> Running git worktree add --track -B gh-pages \\ #> /tmp/RtmpQSXDNq/file170634e2fcab/lesson-example/site/docs \\ #> sandpaper-local/gh-pages #> Preparing worktree (resetting branch 'gh-pages'; was at 12c64a9) #> branch 'gh-pages' set up to track 'sandpaper-local/gh-pages'. #> HEAD is now at 12c64a9 Initializing gh-pages branch #> ::endgroup:: tok <- Sys.time() cli::cli_alert_info(\"Elapsed time: {round(tok - tik, 2)} seconds\") #> ℹ Elapsed time: 0.4 seconds tik <- Sys.time() cli::cli_h1(\"Build Lesson into worktrees\") #> #> ── Build Lesson into worktrees ───────────────────────────────────────── build_lesson(res, quiet = TRUE, preview = FALSE) #> ── Initialising site ─────────────────────────────────────────────────── #> Copying <pkgdown>/BS3/assets/bootstrap-toc.css to bootstrap-toc.css #> Copying <pkgdown>/BS3/assets/bootstrap-toc.js to bootstrap-toc.js #> Copying <pkgdown>/BS3/assets/docsearch.css to docsearch.css #> Copying <pkgdown>/BS3/assets/docsearch.js to docsearch.js #> Copying <pkgdown>/BS3/assets/link.svg to link.svg #> Copying <pkgdown>/BS3/assets/pkgdown.css to pkgdown.css #> Copying <pkgdown>/BS3/assets/pkgdown.js to pkgdown.js #> Copying <varnish>/pkgdown/assets/android-chrome-192x192.png to #> android-chrome-192x192.png #> Copying <varnish>/pkgdown/assets/android-chrome-512x512.png to #> android-chrome-512x512.png #> Copying <varnish>/pkgdown/assets/apple-touch-icon.png to #> apple-touch-icon.png #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.eot to #> assets/fonts/Mulish-Black.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.svg to #> assets/fonts/Mulish-Black.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.ttf to #> assets/fonts/Mulish-Black.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.woff to #> assets/fonts/Mulish-Black.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.woff2 to #> assets/fonts/Mulish-Black.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.eot to #> assets/fonts/Mulish-BlackItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.svg to #> assets/fonts/Mulish-BlackItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.ttf to #> assets/fonts/Mulish-BlackItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.woff #> to assets/fonts/Mulish-BlackItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.woff2 #> to assets/fonts/Mulish-BlackItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.eot to #> assets/fonts/Mulish-Bold.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.svg to #> assets/fonts/Mulish-Bold.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.ttf to #> assets/fonts/Mulish-Bold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.woff to #> assets/fonts/Mulish-Bold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.woff2 to #> assets/fonts/Mulish-Bold.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.eot to #> assets/fonts/Mulish-BoldItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.svg to #> assets/fonts/Mulish-BoldItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.ttf to #> assets/fonts/Mulish-BoldItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.woff to #> assets/fonts/Mulish-BoldItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.woff2 #> to assets/fonts/Mulish-BoldItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.eot to #> assets/fonts/Mulish-ExtraBold.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.svg to #> assets/fonts/Mulish-ExtraBold.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.ttf to #> assets/fonts/Mulish-ExtraBold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.woff to #> assets/fonts/Mulish-ExtraBold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.woff2 to #> assets/fonts/Mulish-ExtraBold.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.eot to #> assets/fonts/Mulish-ExtraBoldItalic.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.svg to #> assets/fonts/Mulish-ExtraBoldItalic.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.ttf to #> assets/fonts/Mulish-ExtraBoldItalic.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.woff to #> assets/fonts/Mulish-ExtraBoldItalic.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.woff2 to #> assets/fonts/Mulish-ExtraBoldItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.eot to #> assets/fonts/Mulish-ExtraLight.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.svg to #> assets/fonts/Mulish-ExtraLight.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.ttf to #> assets/fonts/Mulish-ExtraLight.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.woff to #> assets/fonts/Mulish-ExtraLight.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.woff2 #> to assets/fonts/Mulish-ExtraLight.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.eot to #> assets/fonts/Mulish-ExtraLightItalic.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.svg to #> assets/fonts/Mulish-ExtraLightItalic.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.ttf to #> assets/fonts/Mulish-ExtraLightItalic.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.woff to #> assets/fonts/Mulish-ExtraLightItalic.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.woff2 to #> assets/fonts/Mulish-ExtraLightItalic.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic-VariableFont_wght.ttf #> to assets/fonts/Mulish-Italic-VariableFont_wght.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.eot to #> assets/fonts/Mulish-Italic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.svg to #> assets/fonts/Mulish-Italic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.ttf to #> assets/fonts/Mulish-Italic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.woff to #> assets/fonts/Mulish-Italic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.woff2 to #> assets/fonts/Mulish-Italic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.eot to #> assets/fonts/Mulish-Light.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.svg to #> assets/fonts/Mulish-Light.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.ttf to #> assets/fonts/Mulish-Light.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.woff to #> assets/fonts/Mulish-Light.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.woff2 to #> assets/fonts/Mulish-Light.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.eot to #> assets/fonts/Mulish-LightItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.svg to #> assets/fonts/Mulish-LightItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.ttf to #> assets/fonts/Mulish-LightItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.woff #> to assets/fonts/Mulish-LightItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.woff2 #> to assets/fonts/Mulish-LightItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.eot to #> assets/fonts/Mulish-Medium.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.svg to #> assets/fonts/Mulish-Medium.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.ttf to #> assets/fonts/Mulish-Medium.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.woff to #> assets/fonts/Mulish-Medium.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.woff2 to #> assets/fonts/Mulish-Medium.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.eot #> to assets/fonts/Mulish-MediumItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.svg #> to assets/fonts/Mulish-MediumItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.ttf #> to assets/fonts/Mulish-MediumItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.woff #> to assets/fonts/Mulish-MediumItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.woff2 #> to assets/fonts/Mulish-MediumItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.eot to #> assets/fonts/Mulish-Regular.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.svg to #> assets/fonts/Mulish-Regular.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.ttf to #> assets/fonts/Mulish-Regular.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.woff to #> assets/fonts/Mulish-Regular.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.woff2 to #> assets/fonts/Mulish-Regular.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.eot to #> assets/fonts/Mulish-SemiBold.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.svg to #> assets/fonts/Mulish-SemiBold.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.ttf to #> assets/fonts/Mulish-SemiBold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.woff to #> assets/fonts/Mulish-SemiBold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.woff2 to #> assets/fonts/Mulish-SemiBold.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.eot #> to assets/fonts/Mulish-SemiBoldItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.svg #> to assets/fonts/Mulish-SemiBoldItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.ttf #> to assets/fonts/Mulish-SemiBoldItalic.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.woff to #> assets/fonts/Mulish-SemiBoldItalic.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.woff2 to #> assets/fonts/Mulish-SemiBoldItalic.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-VariableFont_wght.ttf to #> assets/fonts/Mulish-VariableFont_wght.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.eot to #> assets/fonts/MulishExtraLight-Regular.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.svg to #> assets/fonts/MulishExtraLight-Regular.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.woff to #> assets/fonts/MulishExtraLight-Regular.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.woff2 to #> assets/fonts/MulishExtraLight-Regular.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.eot to #> assets/fonts/mulish-v5-latin-regular.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.svg to #> assets/fonts/mulish-v5-latin-regular.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.ttf to #> assets/fonts/mulish-v5-latin-regular.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff to #> assets/fonts/mulish-v5-latin-regular.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff2 to #> assets/fonts/mulish-v5-latin-regular.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff to #> assets/fonts/mulish-variablefont_wght.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff2 to #> assets/fonts/mulish-variablefont_wght.woff2 #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo-sm.svg #> to assets/images/carpentries-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo.svg to #> assets/images/carpentries-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo-sm.svg to #> assets/images/data-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo.svg to #> assets/images/data-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/dropdown-arrow.svg to #> assets/images/dropdown-arrow.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo-sm.svg to #> assets/images/incubator-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo.svg to #> assets/images/incubator-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo-sm.svg to #> assets/images/lab-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo.svg to #> assets/images/lab-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo-sm.svg to #> assets/images/library-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo.svg to #> assets/images/library-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/minus.svg to #> assets/images/minus.svg #> Copying <varnish>/pkgdown/assets/assets/images/plus.svg to #> assets/images/plus.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo-sm.svg to #> assets/images/software-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo.svg to #> assets/images/software-logo.svg #> Copying <varnish>/pkgdown/assets/assets/scripts.js to assets/scripts.js #> Copying <varnish>/pkgdown/assets/assets/styles.css to assets/styles.css #> Copying <varnish>/pkgdown/assets/assets/styles.css.map to #> assets/styles.css.map #> Copying <varnish>/pkgdown/assets/assets/themetoggle.js to #> assets/themetoggle.js #> Copying <varnish>/pkgdown/assets/favicon-16x16.png to favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicon-32x32.png to favicon-32x32.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-114x114.png to #> favicons/cp/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-120x120.png to #> favicons/cp/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-144x144.png to #> favicons/cp/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-152x152.png to #> favicons/cp/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-57x57.png #> to favicons/cp/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-60x60.png #> to favicons/cp/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-72x72.png #> to favicons/cp/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-76x76.png #> to favicons/cp/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-128.png to #> favicons/cp/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-16x16.png to #> favicons/cp/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-196x196.png to #> favicons/cp/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-32x32.png to #> favicons/cp/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-96x96.png to #> favicons/cp/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon.ico to #> favicons/cp/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-144x144.png to #> favicons/cp/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-150x150.png to #> favicons/cp/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x150.png to #> favicons/cp/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x310.png to #> favicons/cp/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-70x70.png to #> favicons/cp/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-114x114.png to #> favicons/dc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-120x120.png to #> favicons/dc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-144x144.png to #> favicons/dc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-152x152.png to #> favicons/dc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-57x57.png #> to favicons/dc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-60x60.png #> to favicons/dc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-72x72.png #> to favicons/dc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-76x76.png #> to favicons/dc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-128.png to #> favicons/dc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-16x16.png to #> favicons/dc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-196x196.png to #> favicons/dc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-32x32.png to #> favicons/dc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-96x96.png to #> favicons/dc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon.ico to #> favicons/dc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-144x144.png to #> favicons/dc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-150x150.png to #> favicons/dc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x150.png to #> favicons/dc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x310.png to #> favicons/dc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-70x70.png to #> favicons/dc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-114x114.png to #> favicons/lc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-120x120.png to #> favicons/lc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-144x144.png to #> favicons/lc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-152x152.png to #> favicons/lc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-57x57.png #> to favicons/lc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-60x60.png #> to favicons/lc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-72x72.png #> to favicons/lc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-76x76.png #> to favicons/lc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-128.png to #> favicons/lc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-16x16.png to #> favicons/lc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-196x196.png to #> favicons/lc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-32x32.png to #> favicons/lc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-96x96.png to #> favicons/lc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon.ico to #> favicons/lc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-144x144.png to #> favicons/lc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-150x150.png to #> favicons/lc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x150.png to #> favicons/lc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x310.png to #> favicons/lc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-70x70.png to #> favicons/lc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-114x114.png to #> favicons/swc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-120x120.png to #> favicons/swc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-144x144.png to #> favicons/swc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-152x152.png to #> favicons/swc/apple-touch-icon-152x152.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-57x57.png to #> favicons/swc/apple-touch-icon-57x57.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-60x60.png to #> favicons/swc/apple-touch-icon-60x60.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-72x72.png to #> favicons/swc/apple-touch-icon-72x72.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-76x76.png to #> favicons/swc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-128.png to #> favicons/swc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-16x16.png to #> favicons/swc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-196x196.png to #> favicons/swc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-32x32.png to #> favicons/swc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-96x96.png to #> favicons/swc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon.ico to #> favicons/swc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-144x144.png to #> favicons/swc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-150x150.png to #> favicons/swc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x150.png to #> favicons/swc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x310.png to #> favicons/swc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-70x70.png to #> favicons/swc/mstile-70x70.png #> Copying <varnish>/pkgdown/assets/mstile-150x150.png to #> mstile-150x150.png #> Copying <varnish>/pkgdown/assets/safari-pinned-tab.svg to #> safari-pinned-tab.svg #> Copying <varnish>/pkgdown/assets/site.webmanifest to site.webmanifest cli::cli_h2(\"git status: {gert::git_branch(repo = res)}\") #> #> ── git status: main ── #> print(gert::git_status(repo = res)) #> # A tibble: 0 × 3 #> # ℹ 3 variables: file <chr>, status <chr>, staged <lgl> cli::cli_h2('git status: {gert::git_branch(repo = fs::path(res, \"site\", \"built\"))}') #> ── git status: md-outputs ── #> print(gert::git_status(repo = fs::path(res, \"site\", \"built\"))) #> # A tibble: 13 × 3 #> file status staged #> <chr> <chr> <lgl> #> 1 CODE_OF_CONDUCT.md new FALSE #> 2 LICENSE.md new FALSE #> 3 config.yaml new FALSE #> 4 fig/ new FALSE #> 5 index.md new FALSE #> 6 instructor-notes.md new FALSE #> 7 introduction.md new FALSE #> 8 learner-profiles.md new FALSE #> 9 links.md new FALSE #> 10 md5sum.txt new FALSE #> 11 reference.md new FALSE #> 12 renv.lock new FALSE #> 13 setup.md new FALSE cli::cli_h2('git status: {gert::git_branch(repo = fs::path(res, \"site\", \"docs\"))}') #> ── git status: gh-pages ── #> print(gert::git_status(repo = fs::path(res, \"site\", \"docs\"))) #> # A tibble: 36 × 3 #> file status staged #> <chr> <chr> <lgl> #> 1 .nojekyll new FALSE #> 2 404.html new FALSE #> 3 CODE_OF_CONDUCT.html new FALSE #> 4 LICENSE.html new FALSE #> 5 aio.html new FALSE #> 6 android-chrome-192x192.png new FALSE #> 7 android-chrome-512x512.png new FALSE #> 8 apple-touch-icon.png new FALSE #> 9 assets/ new FALSE #> 10 bootstrap-toc.css new FALSE #> # ℹ 26 more rows tok <- Sys.time() cli::cli_alert_info(\"Elapsed time: {round(tok - tik, 2)} seconds\") #> ℹ Elapsed time: 12.14 seconds tik <- Sys.time() cli::cli_h1(\"Clean Up\") #> #> ── Clean Up ──────────────────────────────────────────────────────────── cli::cli_alert_info(\"object db is an expression that evaluates to {.code {db}}\") #> ℹ object db is an expression that evaluates to `sandpaper:::github_worktree_remove(\"/tmp/RtmpQSXDNq/file170634e2fcab/lesson-example/site/built\", \"/tmp/RtmpQSXDNq/file170634e2fcab/lesson-example\")` eval(db) #> Running git worktree remove --force \\ #> /tmp/RtmpQSXDNq/file170634e2fcab/lesson-example/site/built #> $status #> [1] 0 #> #> $stdout #> [1] \"\" #> #> $stderr #> [1] \"\" #> #> $timeout #> [1] FALSE #> cli::cli_alert_info(\"object ds is an expression that evaluates to {.code {ds}}\") #> ℹ object ds is an expression that evaluates to `sandpaper:::github_worktree_remove(\"/tmp/RtmpQSXDNq/file170634e2fcab/lesson-example/site/docs\", \"/tmp/RtmpQSXDNq/file170634e2fcab/lesson-example\")` eval(ds) #> Running git worktree remove --force \\ #> /tmp/RtmpQSXDNq/file170634e2fcab/lesson-example/site/docs #> $status #> [1] 0 #> #> $stdout #> [1] \"\" #> #> $stderr #> [1] \"\" #> #> $timeout #> [1] FALSE #> sandpaper:::remove_local_remote(repo = res) #> ℹ removing 'sandpaper-local' (/tmp/RtmpQSXDNq/REMOTE-17064183ffc5) #> /tmp/RtmpQSXDNq/REMOTE-17064183ffc5 sandpaper:::reset_git_user(res) # remove the test fixture and report tryCatch(fs::dir_delete(res), error = function() FALSE) tok <- Sys.time() cli::cli_alert_info(\"Elapsed time: {round(tok - tik, 2)} seconds\") #> ℹ Elapsed time: 0.16 seconds"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/hash_children.html","id":null,"dir":"Reference","previous_headings":"","what":"Update file checksums to account for child documents — hash_children","title":"Update file checksums to account for child documents — hash_children","text":"R Markdown file contains child document, hash replaced hash combined unnamed hashes parent descendants (aka lineage).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/hash_children.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update file checksums to account for child documents — hash_children","text":"","code":"hash_children(checksums, files, lineage) get_lineages(lsn)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/hash_children.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update file checksums to account for child documents — hash_children","text":"checksums hashes parent files files relative path parent files root_path lineage named list character vectors specifying absolute paths full lineage parent Markdown R Markdown files (inclusive). names relative path parent. lsn pegboard::Lesson object","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/hash_children.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update file checksums to account for child documents — hash_children","text":"get_lineages() named list charcter vectors specifying lineage parent files. names relative paths parents. hash_children() character vector hashes length parent files.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/hash_children.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Update file checksums to account for child documents — hash_children","text":"handling child files lessons, important changes child files cause source file change well. get_lineages() function finds child files pegboard::Lesson object. use text database relies hash file determine file rebuilt, hash_children() piggybacks paradigm assigning unique hash parent file children hash vector hashes files. hash hashes created rlang::hash().","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/hash_children.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Update file checksums to account for child documents — hash_children","text":"","code":"# This demonstration will show how a temporary database can be set up. It # will only work with a sandpaper lesson # setup ----------------------------------------------------------------- # The setup needs to include an R Markdown file with a child file. tmp <- tempfile() on.exit(fs::dir_delete(tmp), add = TRUE) #> Error: [ENOENT] Failed to search directory '/tmp/RtmpQSXDNq/file17062ac49bc4': no such file or directory create_lesson(tmp, rmd = FALSE, open = FALSE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062ac49bc4... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062ac49bc4... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062ac49bc4... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062ac49bc4... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062ac49bc4... #> ☐ Edit /tmp/RtmpQSXDNq/file17062ac49bc4/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062ac49bc4... #> ✔ First episode created in /tmp/RtmpQSXDNq/file17062ac49bc4/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062ac49bc4... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062ac49bc4... #> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file17062ac49bc4 #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062ac49bc4... #> /tmp/RtmpQSXDNq/file17062ac49bc4 # get namespace to use internal functions sp <- asNamespace(\"sandpaper\") db <- fs::path(tmp, \"site/built/md5sum.txt\") resources <- fs::path(tmp, c(\"episodes/introduction.md\", \"index.md\")) # create child file writeLines(\"Hello from another file!\\n\", fs::path(tmp, \"episodes\", \"files\", \"hi.md\")) # use child file cat(\"\\n\\n```{r child='files/hi.md'}\\n```\\n\", file = resources[[1]], append = TRUE) # convert to Rmd fs::file_move(resources[[1]], fs::path_ext_set(resources[[1]], \"Rmd\")) resources[[1]] <- fs::path_ext_set(resources[[1]], \"Rmd\") set_episodes(tmp, fs::path_file(resources[[1]]), write = TRUE) # get_lineages ------------------------------------------------------ # we can get the child files by scanning the Lesson object lsn <- sp$this_lesson(tmp) class(lsn) #> [1] \"Lesson\" \"R6\" children <- sp$get_lineages(lsn) print(children) #> $`episodes/introduction.Rmd` #> [1] \"/tmp/RtmpQSXDNq/file17062ac49bc4/episodes/introduction.Rmd\" #> [2] \"/tmp/RtmpQSXDNq/file17062ac49bc4/episodes/files/hi.md\" #> #> $CODE_OF_CONDUCT.md #> /tmp/RtmpQSXDNq/file17062ac49bc4/CODE_OF_CONDUCT.md #> #> $CONTRIBUTING.md #> /tmp/RtmpQSXDNq/file17062ac49bc4/CONTRIBUTING.md #> #> $LICENSE.md #> /tmp/RtmpQSXDNq/file17062ac49bc4/LICENSE.md #> #> $README.md #> /tmp/RtmpQSXDNq/file17062ac49bc4/README.md #> #> $index.md #> /tmp/RtmpQSXDNq/file17062ac49bc4/index.md #> #> $links.md #> /tmp/RtmpQSXDNq/file17062ac49bc4/links.md #> #> $`instructors/instructor-notes.md` #> /tmp/RtmpQSXDNq/file17062ac49bc4/instructors/instructor-notes.md #> #> $`learners/reference.md` #> /tmp/RtmpQSXDNq/file17062ac49bc4/learners/reference.md #> #> $`learners/setup.md` #> /tmp/RtmpQSXDNq/file17062ac49bc4/learners/setup.md #> #> $`profiles/learner-profiles.md` #> /tmp/RtmpQSXDNq/file17062ac49bc4/profiles/learner-profiles.md #> # hash_children --------------------------------------------------- # get hash of parent phash <- tools::md5sum(resources[[1]]) rel_parent <- fs::path_rel(resources[[1]], start = tmp) sp$hash_children(phash, rel_parent, children) #> episodes/introduction.Rmd #> \"f0803606fb41fb5ba9d03df618d492ae\" # demonstrate how this works ---------------- # the combined hashes have their names removed and then `rlang::hash()` # creates the hash of the unnamed hashes. chash <- tools::md5sum(children[[1]]) hashes <- unname(chash) print(hashes) #> [1] \"4c6b9769ec953e27d83c6c707d549b82\" #> [2] \"a649c757324fc9c289e38f3d77c206d5\" rlang::hash(hashes) #> [1] \"f0803606fb41fb5ba9d03df618d492ae\""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/known_languages.html","id":null,"dir":"Reference","previous_headings":"","what":"Show a list of languages known by {sandpaper} — known_languages","title":"Show a list of languages known by {sandpaper} — known_languages","text":"Show list languages known {sandpaper}","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/known_languages.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Show a list of languages known by {sandpaper} — known_languages","text":"","code":"known_languages()"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/known_languages.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Show a list of languages known by {sandpaper} — known_languages","text":"character vector language codes known {sandpaper}","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/known_languages.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Show a list of languages known by {sandpaper} — known_languages","text":"known languages translations menu navigational elements exist {sandpaper}. elements translated given language like add translations , please consult vignette(\"translations\", package = \"sandpaper\") details source code {sandpaper}.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/known_languages.html","id":"list-of-known-languages-","dir":"Reference","previous_headings":"","what":"List of Known Languages:","title":"Show a list of languages known by {sandpaper} — known_languages","text":"","code":"#> - en #> - es #> - fr #> - ja #> - uk"},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/known_languages.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Show a list of languages known by {sandpaper} — known_languages","text":"","code":"known_languages() #> [1] \"en\" \"de\" \"es\" \"fr\" \"ja\" \"uk\""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/lesson_storage.html","id":null,"dir":"Reference","previous_headings":"","what":"Internal cache for storing pre-computed lesson objects — this_lesson","title":"Internal cache for storing pre-computed lesson objects — this_lesson","text":"storage cache pegboard::Lesson objects pre-computed items use internal functions {sandpaper} working.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/lesson_storage.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Internal cache for storing pre-computed lesson objects — this_lesson","text":"","code":"this_lesson(path) clear_this_lesson() set_this_lesson(path) set_resource_list(path) clear_resource_list(path)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/lesson_storage.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Internal cache for storing pre-computed lesson objects — this_lesson","text":"path path current lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/lesson_storage.html","id":"lesson-object-storage","dir":"Reference","previous_headings":"","what":"Lesson Object Storage","title":"Internal cache for storing pre-computed lesson objects — this_lesson","text":"this_lesson() return pegboard::Lesson object previously stored. three values cached: .this_lesson pegboard::Lesson object .this_diff charcter vector gert::git_diff_patch() .this_status data frame gert::git_status() .this_commit hash recent commit function this_lesson() first checks .this_diff different output gert::git_diff_patch(), checks changes gert::git_status(), finally checks commits identical. differences values previously cached, lesson loaded memory, otherwise, fetched previously stored lesson. storage cache global package object called .store, initialised {sandpaper} loaded via .lesson_store() changes git aware , lesson remains .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/lesson_storage.html","id":"pre-computed-object-storage","dir":"Reference","previous_headings":"","what":"Pre-Computed Object Storage","title":"Internal cache for storing pre-computed lesson objects — this_lesson","text":"side-effect this_lesson() also initialise pre-computed objects pertain lesson . initialised via set_globals(). storage objects : .resources: list markdown resources lesson derived get_resource_list() via set_resource_list() this_metadata: metadata template including pages. initialised initialise_metadata() via set_globals() learner_globals: variables learner version pages initialised set_globals() instructor_globals: variables instructor version pages initialised set_globals()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/lesson_storage.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Internal cache for storing pre-computed lesson objects — this_lesson","text":"","code":"tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file170686efd05... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpQSXDNq/file170686efd05... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpQSXDNq/file170686efd05... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpQSXDNq/file170686efd05... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file170686efd05... #> ☐ Edit /tmp/RtmpQSXDNq/file170686efd05/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpQSXDNq/file170686efd05... #> ✔ First episode created in /tmp/RtmpQSXDNq/file170686efd05/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpQSXDNq/file170686efd05... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpQSXDNq/file170686efd05... #> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file170686efd05 #> → Creating Lesson in /tmp/RtmpQSXDNq/file170686efd05... #> /tmp/RtmpQSXDNq/file170686efd05 # Read the lesson into cache system.time(sandpaper:::this_lesson(tmp)) #> user system elapsed #> 0.129 0.008 0.136 system.time(sandpaper:::this_lesson(tmp)) # less time to read in once cached #> user system elapsed #> 0.003 0.000 0.003 l <- sandpaper:::this_lesson(tmp) l #> <Lesson> #> Public: #> blocks: function (type = NULL, level = 0, path = FALSE) #> built: NULL #> challenges: function (path = FALSE, graph = FALSE, recurse = TRUE) #> children: NULL #> clone: function (deep = FALSE) #> episodes: list #> extra: list #> files: active binding #> get: function (element = NULL, collection = \"episodes\") #> handout: function (path = NULL, solution = FALSE) #> has_children: active binding #> initialize: function (path = \".\", rmd = FALSE, jekyll = TRUE, ...) #> isolate_blocks: function () #> load_built: function () #> n_problems: active binding #> overview: FALSE #> path: /tmp/RtmpQSXDNq/file170686efd05 #> reset: function () #> rmd: FALSE #> sandpaper: TRUE #> show_problems: active binding #> solutions: function (path = FALSE) #> summary: function (collection = \"episodes\") #> thin: function (verbose = TRUE) #> trace_lineage: function (episode_path) #> validate_divs: function () #> validate_headings: function (verbose = TRUE) #> validate_links: function () #> Private: #> deep_clone: function (name, value) # clear the cache sandpaper:::clear_this_lesson() system.time(sandpaper:::this_lesson(tmp)) # have to re-read the lesson #> user system elapsed #> 0.131 0.000 0.131 system.time(sandpaper:::this_lesson(tmp)) #> user system elapsed #> 0.005 0.000 0.005 unlink(tmp)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_aio_section.html","id":null,"dir":"Reference","previous_headings":"","what":"Make a section and place it inside the All In One page — make_aio_section","title":"Make a section and place it inside the All In One page — make_aio_section","text":"episode needs added AiO, insert XML nodes episode contents section inside One page.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_aio_section.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Make a section and place it inside the All In One page — make_aio_section","text":"","code":"make_aio_section(name, contents, parent)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_aio_section.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Make a section and place it inside the All In One page — make_aio_section","text":"name name section, prefixed episode- contents episode contents get_content() parent parent div AiO page.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_aio_section.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Make a section and place it inside the All In One page — make_aio_section","text":"section added parent","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_aio_section.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Make a section and place it inside the All In One page — make_aio_section","text":"","code":"if (FALSE) { lsn <- \"/path/to/lesson\" pkg <- pkgdown::as_pkgdown(fs::path(lsn, \"site\")) # read in the All in One page and extract its content aio <- get_content(\"aio\", content = \"self::*\", pkg = pkg) episode_content <- get_content(\"01-introduction\", pkg = pkg) make_aio_section(\"aio-01-introduction\", contents = episode_content, parent = aio ) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_images_section.html","id":null,"dir":"Reference","previous_headings":"","what":"Make a section of aggregated images — make_images_section","title":"Make a section of aggregated images — make_images_section","text":"insert xml figure nodes images page, printing alt text descriptions users using screen readers.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_images_section.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Make a section of aggregated images — make_images_section","text":"","code":"make_images_section(name, contents, parent)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_images_section.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Make a section of aggregated images — make_images_section","text":"name name section, (may may prefixed images-) contents xml_nodeset figure elements get_content() parent parent div images page","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_images_section.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Make a section of aggregated images — make_images_section","text":"section added parent","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_images_section.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Make a section of aggregated images — make_images_section","text":"","code":"if (FALSE) { lsn <- \"/path/to/lesson\" pkg <- pkgdown::as_pkgdown(fs::path(lsn, \"site\")) # read in the All in One page and extract its content img <- get_content(\"images\", content = \"self::*\", pkg = pkg) fig_content <- get_content(\"01-introduction\", content = \"/figure\", pkg = pkg) make_images_section(\"01-introduction\", contents = fig_content, parent = img) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_instructornotes_section.html","id":null,"dir":"Reference","previous_headings":"","what":"Make a section of aggregated instructor notes — make_instructornotes_section","title":"Make a section of aggregated instructor notes — make_instructornotes_section","text":"append instructor notes inline sections lesson instructor-notes page, separated section <hr> elements.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_instructornotes_section.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Make a section of aggregated instructor notes — make_instructornotes_section","text":"","code":"make_instructornotes_section(name, contents, parent)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_instructornotes_section.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Make a section of aggregated instructor notes — make_instructornotes_section","text":"name name section, (may may prefixed images-) contents xml_nodeset figure elements get_content() parent parent div images page","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_instructornotes_section.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Make a section of aggregated instructor notes — make_instructornotes_section","text":"section added parent","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_instructornotes_section.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Make a section of aggregated instructor notes — make_instructornotes_section","text":"learner view, instructor notes present","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/make_instructornotes_section.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Make a section of aggregated instructor notes — make_instructornotes_section","text":"","code":"if (FALSE) { lsn <- \"/path/to/lesson\" pkg <- pkgdown::as_pkgdown(fs::path(lsn, \"site\")) # read in the All in One page and extract its content notes <- get_content(\"instructor-notes\", content = \"section[@id='aggregate-instructor-notes']\", pkg = pkg, instructor = TRUE ) agg <- \"/div[contains(@class, 'instructor-note')]//div[@class='accordion-body']\" note_content <- get_content(\"01-introduction\", content = agg, pkg = pkg) make_instructornotes_section(\"01-introduction\", contents = note_content, parent = notes ) # NOTE: if the object for \"contents\" ends with \"_learn\", no content will be # appended note_learn <- note_content make_instructornotes_section(\"01-introduction\", contents = note_learn, parent = notes ) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/move_episode.html","id":null,"dir":"Reference","previous_headings":"","what":"Move an episode in the schedule — move_episode","title":"Move an episode in the schedule — move_episode","text":"need move single episode, function gives programmatic interactive interface accomplishing task, whether need add episode, draft, remove episode schedule.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/move_episode.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Move an episode in the schedule — move_episode","text":"","code":"move_episode(ep = NULL, position = NULL, write = FALSE, path = \".\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/move_episode.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Move an episode in the schedule — move_episode","text":"ep name draft episode name/number published episode move. position position schedule move episode. Valid positions 0 number episodes (+1 drafts). value 0 indicates episode removed schedule. write defaults FALSE, show potential changes. TRUE, schedule modified written config.yaml path path lesson (defaults current working directory)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/move_episode.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Move an episode in the schedule — move_episode","text":"","code":"if (interactive() || Sys.getenv(\"CI\") != \"\") { tmp <- tempfile() create_lesson(tmp) create_episode_md(\"getting-started\", path = tmp, open = FALSE) create_episode_rmd(\"plotting\", path = tmp, open = FALSE) create_episode_md(\"experimental\", path = tmp, add = FALSE, open = FALSE) set_episodes(tmp, c(\"getting-started.md\", \"introduction.Rmd\", \"plotting.Rmd\"), write = TRUE) # Default episode order is alphabetical, we can use this to nudge episodes get_episodes(tmp) move_episode(\"introduction.Rmd\", 1L, path = tmp) # by default, it shows you the change move_episode(\"introduction.Rmd\", 1L, write = TRUE, path = tmp) # write the results get_episodes(tmp) # Add episodes from the drafts get_drafts(tmp) move_episode(\"experimental.md\", 2L, path = tmp) # view where it will live move_episode(\"experimental.md\", 2L, write = TRUE, path = tmp) get_episodes(tmp) # Unpublish episodes by setting position to zero move_episode(\"experimental.md\", 0L, path = tmp) # view the results move_episode(\"experimental.md\", 0L, write = TRUE, path = tmp) get_episodes(tmp) # Interactively select the position where the episode should go by omitting # the position argument if (interactive()) { move_episode(\"experimental.md\", path = tmp) } } #> → Creating Lesson in /tmp/RtmpQSXDNq/file17066e51660f... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17066e51660f... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17066e51660f... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpQSXDNq/file17066e51660f... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file17066e51660f... #> ☐ Edit /tmp/RtmpQSXDNq/file17066e51660f/episodes/introduction.Rmd. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17066e51660f... #> ✔ First episode created in /tmp/RtmpQSXDNq/file17066e51660f/episodes/introduction.Rmd #> → Creating Lesson in /tmp/RtmpQSXDNq/file17066e51660f... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpQSXDNq/file17066e51660f... #> ℹ Consent to use package cache provided #> → Creating Lesson in /tmp/RtmpQSXDNq/file17066e51660f... #> - The project is out-of-sync -- use `renv::status()` for details. #> → Searching for and installing available dependencies #> The following packages were discovered: #> #> # ~/work/_temp/Library ------------------------------------------------------- #> - R6 2.5.1 #> - base64enc 0.1-3 #> - bslib 0.8.0 #> - cachem 1.1.0 #> - cli 3.6.3 #> - digest 0.6.37 #> - evaluate 1.0.1 #> - fastmap 1.2.0 #> - fontawesome 0.5.2 #> - fs 1.6.5 #> - glue 1.8.0 #> - highr 0.11 #> - htmltools 0.5.8.1 #> - jquerylib 0.1.4 #> - jsonlite 1.8.9 #> - knitr 1.48 #> - lifecycle 1.0.4 #> - memoise 2.0.1 #> - mime 0.12 #> - rappdirs 0.3.3 #> - rlang 1.1.4 #> - rmarkdown 2.29 #> - sass 0.4.9 #> - tinytex 0.54 #> - xfun 0.49 #> - yaml 2.3.10 #> #> They will be copied into the project library. #> #> - Copying packages into the project library ... Done! #> - Hydrated 26 packages in 0.21 seconds. #> - The project is out-of-sync -- use `renv::status()` for details. #> → Recording changes in lockfile #> The following package(s) will be updated in the lockfile: #> #> # https://packagemanager.posit.co/cran/__linux__/jammy/latest ---------------- #> - R6 [* -> 2.5.1] #> - base64enc [* -> 0.1-3] #> - bslib [* -> 0.8.0] #> - cachem [* -> 1.1.0] #> - cli [* -> 3.6.3] #> - digest [* -> 0.6.37] #> - evaluate [* -> 1.0.1] #> - fastmap [* -> 1.2.0] #> - fontawesome [* -> 0.5.2] #> - fs [* -> 1.6.5] #> - glue [* -> 1.8.0] #> - highr [* -> 0.11] #> - htmltools [* -> 0.5.8.1] #> - jquerylib [* -> 0.1.4] #> - jsonlite [* -> 1.8.9] #> - knitr [* -> 1.48] #> - lifecycle [* -> 1.0.4] #> - memoise [* -> 2.0.1] #> - mime [* -> 0.12] #> - rappdirs [* -> 0.3.3] #> - renv [* -> 1.0.11] #> - rlang [* -> 1.1.4] #> - rmarkdown [* -> 2.29] #> - sass [* -> 0.4.9] #> - tinytex [* -> 0.54] #> - xfun [* -> 0.49] #> - yaml [* -> 2.3.10] #> #> The version of R recorded in the lockfile will be updated: #> - R [* -> 4.4.2] #> #> - Lockfile written to \"/tmp/RtmpQSXDNq/file17066e51660f/renv/profiles/lesson-requirements/renv.lock\". #> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file17066e51660f #> → Creating Lesson in /tmp/RtmpQSXDNq/file17066e51660f... #> ☐ Edit /tmp/RtmpQSXDNq/file17066e51660f/episodes/getting-started.md. #> ☐ Edit /tmp/RtmpQSXDNq/file17066e51660f/episodes/plotting.Rmd. #> ☐ Edit /tmp/RtmpQSXDNq/file17066e51660f/episodes/experimental.md. #> episodes: #> - introduction.Rmd #> - getting-started.md #> - plotting.Rmd #> #> ──────────────────────────────────────────────────────────────────────── #> ℹ To save this configuration, use #> #> move_episode(ep = \"introduction.Rmd\", position = 1, path = tmp, write = TRUE) #> ℹ Files are in draft: episodes/experimental.md #> ℹ All files in learners/ published (config.yaml empty) #> ℹ All files in instructors/ published (config.yaml empty) #> ℹ All files in profiles/ published (config.yaml empty) #> episodes: #> - introduction.Rmd #> - experimental.md #> - getting-started.md #> - plotting.Rmd #> #> ──────────────────────────────────────────────────────────────────────── #> ℹ To save this configuration, use #> #> move_episode(ep = \"experimental.md\", position = 2, path = tmp, write = TRUE) #> episodes: #> - introduction.Rmd #> - getting-started.md #> - plotting.Rmd #> #> ── Removed episodes ──────────────────────────────────────────────────── #> - experimental.md #> ──────────────────────────────────────────────────────────────────────── #> ℹ To save this configuration, use #> #> move_episode(ep = \"experimental.md\", position = 0, path = tmp, write = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":null,"dir":"Reference","previous_headings":"","what":"Give Consent to Use Package Cache — use_package_cache","title":"Give Consent to Use Package Cache — use_package_cache","text":"functions explicitly gives sandpaper permission use renv create package cache future lessons. two states can use: use_package_cache(): Gives explicit permission set use package cache lesson. no_package_cache(): Temporarily suspends permission use package cache lesson, regardless previously given. package cache defined, can use changes lockfile trigger rebuilds lesson. , can use: package_cache_trigger(TRUE) function best used conjunction update_cache()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Give Consent to Use Package Cache — use_package_cache","text":"","code":"use_package_cache(prompt = interactive(), quiet = !prompt) no_package_cache() package_cache_trigger(rebuild = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Give Consent to Use Package Cache — use_package_cache","text":"prompt TRUE (default interactive), prompt consent giving information proposed modifications appear screen asking user choose apply changes . quiet TRUE, messages issued unless prompt = TRUE. defaults opposite prompt. rebuild new value sandpaper.package_cache_trigger global option. Setting TRUE result materials rebuilt new records enter package cache lockfile even source files changed. Setting FALSE return default state, rebuld source files changed. default NULL, nothing.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Give Consent to Use Package Cache — use_package_cache","text":"nothing. used side-effect value getOption(\"sandpaper.package_cache_trigger\") FALSE, unset.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"background","dir":"Reference","previous_headings":"","what":"Background","title":"Give Consent to Use Package Cache — use_package_cache","text":"default, sandpaper happily build lesson using packages available default R library, can undesirable couple reasons: may different version lesson package used lesson website, may result strange errors, warnings, incorrect output. might cautious updating components current R infrastructure work depends correct package versions installed. alleviate concerns, sandpaper uses renv package generate lesson-specific library package versions pinned lesson authors choose update . designed minimally-invasive, using packages already downloading external repositories necessary.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"what-if-i-have-used-renv-before-","dir":"Reference","previous_headings":"","what":"What if I have used renv before?","title":"Give Consent to Use Package Cache — use_package_cache","text":"used renv past, need give consent use cache.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"how-do-i-turn-off-the-feature-temporarily-","dir":"Reference","previous_headings":"","what":"How do I turn off the feature temporarily?","title":"Give Consent to Use Package Cache — use_package_cache","text":"turn feature can use no_package_cache(). sandpaper respect option building lesson use global library instead.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"i-have-used-renv-before-how-do-i-turn-it-off-before-sandpaper-loads-","dir":"Reference","previous_headings":"","what":"I have used renv before; how do I turn it off before sandpaper loads?","title":"Give Consent to Use Package Cache — use_package_cache","text":"can set options(sandpaper.use_renv = FALSE) loading {sandpaper}.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/package_cache.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Give Consent to Use Package Cache — use_package_cache","text":"","code":"if (!getOption(\"sandpaper.use_renv\") && interactive()) { # The first time you set up `{renv}`, you will need permission use_package_cache(prompt = TRUE) # The package cache trigger is FALSE, by default default <- package_cache_trigger() # You can set this to `TRUE` when you update packages with `update_cache()` package_cache_trigger(TRUE) # set the trigger back to its former state package_cache_trigger(default) } if (getOption(\"sandpaper.use_renv\") && interactive()) { # If you have previously used `{renv}`, permission is implied use_package_cache(prompt = TRUE) # You can temporarily turn this off no_package_cache() getOption(\"sandpaper.use_renv\") # should be FALSE use_package_cache(prompt = TRUE) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/parse_file_matches.html","id":null,"dir":"Reference","previous_headings":"","what":"Subset file matches to the order they appear in the config file — parse_file_matches","title":"Subset file matches to the order they appear in the config file — parse_file_matches","text":"Subset file matches order appear config file","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/parse_file_matches.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Subset file matches to the order they appear in the config file — parse_file_matches","text":"","code":"parse_file_matches(reality, hopes = NULL, warn = FALSE, subfolder)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/parse_file_matches.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Subset file matches to the order they appear in the config file — parse_file_matches","text":"reality list paths exist lesson hopes list files order appear lesson warn boolean. TRUE sandpaper.show_draft option set TRUE, files hopes shown screen drafts subfolder character. folder find files hopes. used creating error message.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/parse_file_matches.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Subset file matches to the order they appear in the config file — parse_file_matches","text":"character vector reality subset order hopes","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/parse_file_matches.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Subset file matches to the order they appear in the config file — parse_file_matches","text":"","code":"# setup ---------------------------------------------------- # # NOTE: we need to define our namespace here because using `:::` # in example calls is illegal. snd <- asNamespace(\"sandpaper\") print(need <- c(\"a\", \"bunch\", \"of\", \"silly\", \"files\")) #> [1] \"a\" \"bunch\" \"of\" \"silly\" \"files\" print(exists <- fs::path(\"path\", \"to\", sample(need))) #> path/to/a path/to/bunch path/to/of path/to/silly path/to/files # Rearrange files ------------------------------------------ snd$parse_file_matches(reality = exists, hopes = need, subfolder = \"episodes\") #> path/to/a path/to/bunch path/to/of path/to/silly path/to/files # a subset of files ---------------------------------------- snd$parse_file_matches(reality = exists, hopes = need[4:5], subfolder = \"episodes\") #> path/to/silly path/to/files # a subset of files with a warning ------------------------- op <- getOption(\"sandpaper.show_draft\") options(sandpaper.show_draft = TRUE) on.exit(options(sandpaper.show_draft = op)) snd$parse_file_matches(reality = exists, hopes = need[-(4:5)], warn = TRUE, subfolder = \"episodes\") #> path/to/a path/to/bunch path/to/of # files that do not exist give an error -------------------- try(snd$parse_file_matches(reality = exists, hopes = c(\"these\", need[4:5]), subfolder = \"episodes\")) #> episodes: #> - ✖ these #> - silly #> - files #> Error in error_missing_config(hopes, real_files, subfolder) : #> All files in config.yaml must exist #> • Files marked with ✖ are not present"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/provision.html","id":null,"dir":"Reference","previous_headings":"","what":"Provision an aggregate page in a lesson — provision_agg_page","title":"Provision an aggregate page in a lesson — provision_agg_page","text":"function provision page using reusable template provisioned aggregate pages used lesson avoid unnecessary re-rendering already rendered content.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/provision.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Provision an aggregate page in a lesson — provision_agg_page","text":"","code":"provision_agg_page(pkg, title = \"Key Points\", slug = \"key-points\", new = FALSE) provision_extra_template(pkg, quiet = TRUE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/provision.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Provision an aggregate page in a lesson — provision_agg_page","text":"pkg object created via pkgdown::as_pkgdown() lesson. title new page title slug slug page (e.g. \"aio\" become \"aio.html\") new TRUE, (default), page generated new template. FALSE, page assumed pre-built appended .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/provision.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Provision an aggregate page in a lesson — provision_agg_page","text":"provision_agg_page(): list: $learner: xml_document templated learner page $instructor: xml_document templated instructor page $needs_episodes: logical indicating page completly rebuilt (currently default TRUE) provision_extra_template(): invisibly, copy global list HTML template content available internal global object sandpaper:::.html: .html$template$extra$learner: rendered learner template string .html$template$extra$instructor: rendered instructor template string","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/provision.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Provision an aggregate page in a lesson — provision_agg_page","text":"Pkgdown provides lot services rendering: cross-linking syntax highlighting dynamic templating etc. problem effort takes time scales size page rendered cases can take ~2 seconds One page small lesson. Creating aggregate pages markdown content rendered involve re-rendering content. Luckily, reading content xml2::read_html() quick using XPath queries, can take parts need rendered content insert template, store character .html global object can passed around functions without needing argument. provision_agg_page() makes copy cache, replaces FIXME values appropriate elements, returns object created xml2::read_html() instructor learner veiws.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/provision.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Provision an aggregate page in a lesson — provision_agg_page","text":"","code":"if (FALSE) { # only run if you have provisioned a pkgdown site lsn_site <- \"/path/to/lesson/site\" pkg <- pkgdown::as_pkgdown(lsn_site) # create an AIO page provision_agg_page(pkg, title = \"All In One\", slug = \"aio\", quiet = FALSE) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/read_all_html.html","id":null,"dir":"Reference","previous_headings":"","what":"read all HTML files in a folder — read_all_html","title":"read all HTML files in a folder — read_all_html","text":"read HTML files folder","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/read_all_html.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"read all HTML files in a folder — read_all_html","text":"","code":"read_all_html(path)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/read_all_html.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"read all HTML files in a folder — read_all_html","text":"path path folder HTML files","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/read_all_html.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"read all HTML files in a folder — read_all_html","text":"nested list html_documents xml2::read_html() two top-level elements: $learner: contains html pages learner view $instructor: pages instructor view $paths: absolute paths pages","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/read_all_html.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"read all HTML files in a folder — read_all_html","text":"","code":"tmpdir <- tempfile() on.exit(fs::dir_delete(tmpdir)) #> Error: [ENOENT] Failed to search directory '/tmp/RtmpQSXDNq/file17064267d9fc': no such file or directory fs::dir_create(tmpdir) fs::dir_create(fs::path(tmpdir, \"instructor\")) writeLines(\"<p>Instructor<\/p>\", fs::path(tmpdir, \"instructor\", \"index.html\")) writeLines(\"<p>Learner<\/p>\", fs::path(tmpdir, \"index.html\")) sandpaper:::read_all_html(tmpdir) #> $instructor #> $instructor$index #> {html_document} #> <html> #> [1] <body><p>Instructor<\/p><\/body> #> #> #> $learner #> $learner$index #> {html_document} #> <html> #> [1] <body><p>Learner<\/p><\/body> #> #> #> $paths #> /tmp/RtmpQSXDNq/file17064267d9fc/index.html #> /tmp/RtmpQSXDNq/file17064267d9fc/instructor/index.html #>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/render_html.html","id":null,"dir":"Reference","previous_headings":"","what":"Render html from a markdown file — render_html","title":"Render html from a markdown file — render_html","text":"uses rmarkdown::pandoc_convert() render HTML markdown file. specified pandoc extensions align features desired Carpentries markdown_in_html_blocks, tex_math_dollars, native_divs.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/render_html.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Render html from a markdown file — render_html","text":"","code":"render_html(path_in, ..., quiet = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/render_html.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Render html from a markdown file — render_html","text":"path_in path markdown file ... extra options (e.g. lua filters) passed pandoc quiet TRUE, output produced. Default FALSE, reports markdown build via pandoc","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/render_html.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Render html from a markdown file — render_html","text":"character containing rendred HTML file","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/render_html.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Render html from a markdown file — render_html","text":"","code":"if (rmarkdown::pandoc_available(\"2.11\")) { # first example---markdown to HTML tmp <- tempfile() ex <- c(\"# Markdown\", \"\", \"::: challenge\", \"\", \"How do you write markdown divs?\", \"\", \":::\" ) writeLines(ex, tmp) cat(sandpaper:::render_html(tmp)) # adding a lua filter lua <- tempfile() lu <- c(\"Str = function (elem)\", \" if elem.text == 'markdown' then\", \" return pandoc.Emph {pandoc.Str 'mowdrank'}\", \" end\", \"end\") writeLines(lu, lua) lf <- paste0(\"--lua-filter=\", lua) cat(sandpaper:::render_html(tmp, lf)) } #> <div id=\"markdown\" class=\"section level1\"> #> <h1>Markdown<\/h1> #> <div id=\"discussion1\" class=\"callout discussion\"> #> <div class=\"callout-square\"> #> <i class='callout-icon' data-feather='message-circle'><\/i> #> <\/div> #> <div class=\"section level3 callout-title callout-inner\"> #> <h3 class=\"callout-title\">Challenge<\/h3> #> <div class=\"callout-content\"> #> <p>How do you write markdown divs?<\/p> #> <\/div> #> <\/div> #> <\/div> #> <\/div><div id=\"markdown\" class=\"section level1\"> #> <h1>Markdown<\/h1> #> <div id=\"discussion1\" class=\"callout discussion\"> #> <div class=\"callout-square\"> #> <i class='callout-icon' data-feather='message-circle'><\/i> #> <\/div> #> <div class=\"section level3 callout-title callout-inner\"> #> <h3 class=\"callout-title\">Challenge<\/h3> #> <div class=\"callout-content\"> #> <p>How do you write <em>mowdrank<\/em> divs?<\/p> #> <\/div> #> <\/div> #> <\/div> #> <\/div>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/renv_diagnostics.html","id":null,"dir":"Reference","previous_headings":"","what":"Print a diagnostics report for the package cache — renv_diagnostics","title":"Print a diagnostics report for the package cache — renv_diagnostics","text":"Print diagnostics report package cache","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/renv_diagnostics.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Print a diagnostics report for the package cache — renv_diagnostics","text":"","code":"renv_diagnostics(path = \".\", profile = \"lesson-requirements\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/renv_diagnostics.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Print a diagnostics report for the package cache — renv_diagnostics","text":"path path lesson use diagnostics profile profile work (defaults \"lesson-requirements\"","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/renv_lockfile_hash.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the hash for the previous and current lockfile (as recorded in the lesson) — renv_lockfile_hash","title":"Get the hash for the previous and current lockfile (as recorded in the lesson) — renv_lockfile_hash","text":"Get hash previous current lockfile (recorded lesson)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/renv_lockfile_hash.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the hash for the previous and current lockfile (as recorded in the lesson) — renv_lockfile_hash","text":"","code":"renv_lockfile_hash(path, db_path, profile = \"lesson-requirements\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/renv_lockfile_hash.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the hash for the previous and current lockfile (as recorded in the lesson) — renv_lockfile_hash","text":"path path lesson db_path path database profile name profile renv uses lesson requirements","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/renv_lockfile_hash.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the hash for the previous and current lockfile (as recorded in the lesson) — renv_lockfile_hash","text":"named list: old: hash value recoreded database new: hash value current file","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":null,"dir":"Reference","previous_headings":"","what":"Filter reserved markdown files from the built db — reserved_db","title":"Filter reserved markdown files from the built db — reserved_db","text":"provides service build_site() build files used aggregation, resource provision, GitHub specific files","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Filter reserved markdown files from the built db — reserved_db","text":"","code":"reserved_db(db)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Filter reserved markdown files from the built db — reserved_db","text":"db database get_built_db()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Filter reserved markdown files from the built db — reserved_db","text":"database files filtered ","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Filter reserved markdown files from the built db — reserved_db","text":"three types files reserved want propogate HTML site","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":"github-specific-files","dir":"Reference","previous_headings":"","what":"GitHub specific files","title":"Filter reserved markdown files from the built db — reserved_db","text":"README CONTRIBUTING files. files provide information useful context GitHub","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":"aggregation-files","dir":"Reference","previous_headings":"","what":"Aggregation files","title":"Filter reserved markdown files from the built db — reserved_db","text":"files aggregated together files content appended : index learners/setup concatenated markdown files profiles/ concatenated instructors/instructor-notes inline instructor notes concatenated.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reserved_db.html","id":"resource-provision-files","dir":"Reference","previous_headings":"","what":"Resource provision files","title":"Filter reserved markdown files from the built db — reserved_db","text":"moment, one file use resource provision propogated site: links. provides global links lesson. provides content .","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_episodes.html","id":null,"dir":"Reference","previous_headings":"","what":"Clear the schedule in the lesson — reset_episodes","title":"Clear the schedule in the lesson — reset_episodes","text":"Clear schedule lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_episodes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clear the schedule in the lesson — reset_episodes","text":"","code":"reset_episodes(path = \".\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_episodes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clear the schedule in the lesson — reset_episodes","text":"path path lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_episodes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Clear the schedule in the lesson — reset_episodes","text":"NULL, invisibly","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_episodes.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Clear the schedule in the lesson — reset_episodes","text":"","code":"tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706622bcd93... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706622bcd93... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706622bcd93... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706622bcd93... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706622bcd93... #> ☐ Edit /tmp/RtmpQSXDNq/file1706622bcd93/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706622bcd93... #> ✔ First episode created in /tmp/RtmpQSXDNq/file1706622bcd93/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706622bcd93... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706622bcd93... #> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file1706622bcd93 #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706622bcd93... #> /tmp/RtmpQSXDNq/file1706622bcd93 get_episodes(tmp) # produces warning #> [1] \"introduction.md\" set_episodes(tmp, get_episodes(tmp), write = TRUE) get_episodes(tmp) # no warning #> [1] \"introduction.md\" reset_episodes(tmp) get_episodes(tmp) # produces warning again because there is no schedule #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> [1] \"introduction.md\""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove all files associated with the site — reset_site","title":"Remove all files associated with the site — reset_site","text":"Use want rebuild site scratch.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove all files associated with the site — reset_site","text":"","code":"reset_site(path = \".\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_site.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove all files associated with the site — reset_site","text":"path path site","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/reset_site.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Remove all files associated with the site — reset_site","text":"","code":"tmp <- tempfile() create_lesson(tmp, open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file170621e413f8... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpQSXDNq/file170621e413f8... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpQSXDNq/file170621e413f8... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpQSXDNq/file170621e413f8... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file170621e413f8... #> ☐ Edit /tmp/RtmpQSXDNq/file170621e413f8/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpQSXDNq/file170621e413f8... #> ✔ First episode created in /tmp/RtmpQSXDNq/file170621e413f8/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpQSXDNq/file170621e413f8... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpQSXDNq/file170621e413f8... #> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file170621e413f8 #> → Creating Lesson in /tmp/RtmpQSXDNq/file170621e413f8... #> /tmp/RtmpQSXDNq/file170621e413f8 build_lesson(tmp, preview = FALSE) #> ── Initialising site ─────────────────────────────────────────────────── #> Copying <pkgdown>/BS3/assets/bootstrap-toc.css to bootstrap-toc.css #> Copying <pkgdown>/BS3/assets/bootstrap-toc.js to bootstrap-toc.js #> Copying <pkgdown>/BS3/assets/docsearch.css to docsearch.css #> Copying <pkgdown>/BS3/assets/docsearch.js to docsearch.js #> Copying <pkgdown>/BS3/assets/link.svg to link.svg #> Copying <pkgdown>/BS3/assets/pkgdown.css to pkgdown.css #> Copying <pkgdown>/BS3/assets/pkgdown.js to pkgdown.js #> Copying <varnish>/pkgdown/assets/android-chrome-192x192.png to #> android-chrome-192x192.png #> Copying <varnish>/pkgdown/assets/android-chrome-512x512.png to #> android-chrome-512x512.png #> Copying <varnish>/pkgdown/assets/apple-touch-icon.png to #> apple-touch-icon.png #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.eot to #> assets/fonts/Mulish-Black.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.svg to #> assets/fonts/Mulish-Black.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.ttf to #> assets/fonts/Mulish-Black.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.woff to #> assets/fonts/Mulish-Black.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Black.woff2 to #> assets/fonts/Mulish-Black.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.eot to #> assets/fonts/Mulish-BlackItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.svg to #> assets/fonts/Mulish-BlackItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.ttf to #> assets/fonts/Mulish-BlackItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.woff #> to assets/fonts/Mulish-BlackItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BlackItalic.woff2 #> to assets/fonts/Mulish-BlackItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.eot to #> assets/fonts/Mulish-Bold.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.svg to #> assets/fonts/Mulish-Bold.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.ttf to #> assets/fonts/Mulish-Bold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.woff to #> assets/fonts/Mulish-Bold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Bold.woff2 to #> assets/fonts/Mulish-Bold.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.eot to #> assets/fonts/Mulish-BoldItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.svg to #> assets/fonts/Mulish-BoldItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.ttf to #> assets/fonts/Mulish-BoldItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.woff to #> assets/fonts/Mulish-BoldItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-BoldItalic.woff2 #> to assets/fonts/Mulish-BoldItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.eot to #> assets/fonts/Mulish-ExtraBold.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.svg to #> assets/fonts/Mulish-ExtraBold.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.ttf to #> assets/fonts/Mulish-ExtraBold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.woff to #> assets/fonts/Mulish-ExtraBold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBold.woff2 to #> assets/fonts/Mulish-ExtraBold.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.eot to #> assets/fonts/Mulish-ExtraBoldItalic.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.svg to #> assets/fonts/Mulish-ExtraBoldItalic.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.ttf to #> assets/fonts/Mulish-ExtraBoldItalic.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.woff to #> assets/fonts/Mulish-ExtraBoldItalic.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraBoldItalic.woff2 to #> assets/fonts/Mulish-ExtraBoldItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.eot to #> assets/fonts/Mulish-ExtraLight.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.svg to #> assets/fonts/Mulish-ExtraLight.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.ttf to #> assets/fonts/Mulish-ExtraLight.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.woff to #> assets/fonts/Mulish-ExtraLight.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLight.woff2 #> to assets/fonts/Mulish-ExtraLight.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.eot to #> assets/fonts/Mulish-ExtraLightItalic.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.svg to #> assets/fonts/Mulish-ExtraLightItalic.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.ttf to #> assets/fonts/Mulish-ExtraLightItalic.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.woff to #> assets/fonts/Mulish-ExtraLightItalic.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-ExtraLightItalic.woff2 to #> assets/fonts/Mulish-ExtraLightItalic.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic-VariableFont_wght.ttf #> to assets/fonts/Mulish-Italic-VariableFont_wght.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.eot to #> assets/fonts/Mulish-Italic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.svg to #> assets/fonts/Mulish-Italic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.ttf to #> assets/fonts/Mulish-Italic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.woff to #> assets/fonts/Mulish-Italic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Italic.woff2 to #> assets/fonts/Mulish-Italic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.eot to #> assets/fonts/Mulish-Light.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.svg to #> assets/fonts/Mulish-Light.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.ttf to #> assets/fonts/Mulish-Light.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.woff to #> assets/fonts/Mulish-Light.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Light.woff2 to #> assets/fonts/Mulish-Light.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.eot to #> assets/fonts/Mulish-LightItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.svg to #> assets/fonts/Mulish-LightItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.ttf to #> assets/fonts/Mulish-LightItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.woff #> to assets/fonts/Mulish-LightItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-LightItalic.woff2 #> to assets/fonts/Mulish-LightItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.eot to #> assets/fonts/Mulish-Medium.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.svg to #> assets/fonts/Mulish-Medium.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.ttf to #> assets/fonts/Mulish-Medium.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.woff to #> assets/fonts/Mulish-Medium.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Medium.woff2 to #> assets/fonts/Mulish-Medium.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.eot #> to assets/fonts/Mulish-MediumItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.svg #> to assets/fonts/Mulish-MediumItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.ttf #> to assets/fonts/Mulish-MediumItalic.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.woff #> to assets/fonts/Mulish-MediumItalic.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-MediumItalic.woff2 #> to assets/fonts/Mulish-MediumItalic.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.eot to #> assets/fonts/Mulish-Regular.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.svg to #> assets/fonts/Mulish-Regular.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.ttf to #> assets/fonts/Mulish-Regular.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.woff to #> assets/fonts/Mulish-Regular.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-Regular.woff2 to #> assets/fonts/Mulish-Regular.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.eot to #> assets/fonts/Mulish-SemiBold.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.svg to #> assets/fonts/Mulish-SemiBold.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.ttf to #> assets/fonts/Mulish-SemiBold.ttf #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.woff to #> assets/fonts/Mulish-SemiBold.woff #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBold.woff2 to #> assets/fonts/Mulish-SemiBold.woff2 #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.eot #> to assets/fonts/Mulish-SemiBoldItalic.eot #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.svg #> to assets/fonts/Mulish-SemiBoldItalic.svg #> Copying <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.ttf #> to assets/fonts/Mulish-SemiBoldItalic.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.woff to #> assets/fonts/Mulish-SemiBoldItalic.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-SemiBoldItalic.woff2 to #> assets/fonts/Mulish-SemiBoldItalic.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/Mulish-VariableFont_wght.ttf to #> assets/fonts/Mulish-VariableFont_wght.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.eot to #> assets/fonts/MulishExtraLight-Regular.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.svg to #> assets/fonts/MulishExtraLight-Regular.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.woff to #> assets/fonts/MulishExtraLight-Regular.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/MulishExtraLight-Regular.woff2 to #> assets/fonts/MulishExtraLight-Regular.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.eot to #> assets/fonts/mulish-v5-latin-regular.eot #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.svg to #> assets/fonts/mulish-v5-latin-regular.svg #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.ttf to #> assets/fonts/mulish-v5-latin-regular.ttf #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff to #> assets/fonts/mulish-v5-latin-regular.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-v5-latin-regular.woff2 to #> assets/fonts/mulish-v5-latin-regular.woff2 #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff to #> assets/fonts/mulish-variablefont_wght.woff #> Copying #> <varnish>/pkgdown/assets/assets/fonts/mulish-variablefont_wght.woff2 to #> assets/fonts/mulish-variablefont_wght.woff2 #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo-sm.svg #> to assets/images/carpentries-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/carpentries-logo.svg to #> assets/images/carpentries-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo-sm.svg to #> assets/images/data-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/data-logo.svg to #> assets/images/data-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/dropdown-arrow.svg to #> assets/images/dropdown-arrow.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo-sm.svg to #> assets/images/incubator-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/incubator-logo.svg to #> assets/images/incubator-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo-sm.svg to #> assets/images/lab-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/lab-logo.svg to #> assets/images/lab-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo-sm.svg to #> assets/images/library-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/library-logo.svg to #> assets/images/library-logo.svg #> Copying <varnish>/pkgdown/assets/assets/images/minus.svg to #> assets/images/minus.svg #> Copying <varnish>/pkgdown/assets/assets/images/plus.svg to #> assets/images/plus.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo-sm.svg to #> assets/images/software-logo-sm.svg #> Copying <varnish>/pkgdown/assets/assets/images/software-logo.svg to #> assets/images/software-logo.svg #> Copying <varnish>/pkgdown/assets/assets/scripts.js to assets/scripts.js #> Copying <varnish>/pkgdown/assets/assets/styles.css to assets/styles.css #> Copying <varnish>/pkgdown/assets/assets/styles.css.map to #> assets/styles.css.map #> Copying <varnish>/pkgdown/assets/assets/themetoggle.js to #> assets/themetoggle.js #> Copying <varnish>/pkgdown/assets/favicon-16x16.png to favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicon-32x32.png to favicon-32x32.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-114x114.png to #> favicons/cp/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-120x120.png to #> favicons/cp/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-144x144.png to #> favicons/cp/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-152x152.png to #> favicons/cp/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-57x57.png #> to favicons/cp/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-60x60.png #> to favicons/cp/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-72x72.png #> to favicons/cp/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/cp/apple-touch-icon-76x76.png #> to favicons/cp/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-128.png to #> favicons/cp/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-16x16.png to #> favicons/cp/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-196x196.png to #> favicons/cp/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-32x32.png to #> favicons/cp/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon-96x96.png to #> favicons/cp/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/cp/favicon.ico to #> favicons/cp/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-144x144.png to #> favicons/cp/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-150x150.png to #> favicons/cp/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x150.png to #> favicons/cp/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-310x310.png to #> favicons/cp/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/cp/mstile-70x70.png to #> favicons/cp/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-114x114.png to #> favicons/dc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-120x120.png to #> favicons/dc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-144x144.png to #> favicons/dc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-152x152.png to #> favicons/dc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-57x57.png #> to favicons/dc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-60x60.png #> to favicons/dc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-72x72.png #> to favicons/dc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/dc/apple-touch-icon-76x76.png #> to favicons/dc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-128.png to #> favicons/dc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-16x16.png to #> favicons/dc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-196x196.png to #> favicons/dc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-32x32.png to #> favicons/dc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon-96x96.png to #> favicons/dc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/dc/favicon.ico to #> favicons/dc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-144x144.png to #> favicons/dc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-150x150.png to #> favicons/dc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x150.png to #> favicons/dc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-310x310.png to #> favicons/dc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/dc/mstile-70x70.png to #> favicons/dc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-114x114.png to #> favicons/lc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-120x120.png to #> favicons/lc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-144x144.png to #> favicons/lc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-152x152.png to #> favicons/lc/apple-touch-icon-152x152.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-57x57.png #> to favicons/lc/apple-touch-icon-57x57.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-60x60.png #> to favicons/lc/apple-touch-icon-60x60.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-72x72.png #> to favicons/lc/apple-touch-icon-72x72.png #> Copying <varnish>/pkgdown/assets/favicons/lc/apple-touch-icon-76x76.png #> to favicons/lc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-128.png to #> favicons/lc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-16x16.png to #> favicons/lc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-196x196.png to #> favicons/lc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-32x32.png to #> favicons/lc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon-96x96.png to #> favicons/lc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/lc/favicon.ico to #> favicons/lc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-144x144.png to #> favicons/lc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-150x150.png to #> favicons/lc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x150.png to #> favicons/lc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-310x310.png to #> favicons/lc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/lc/mstile-70x70.png to #> favicons/lc/mstile-70x70.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-114x114.png to #> favicons/swc/apple-touch-icon-114x114.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-120x120.png to #> favicons/swc/apple-touch-icon-120x120.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-144x144.png to #> favicons/swc/apple-touch-icon-144x144.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-152x152.png to #> favicons/swc/apple-touch-icon-152x152.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-57x57.png to #> favicons/swc/apple-touch-icon-57x57.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-60x60.png to #> favicons/swc/apple-touch-icon-60x60.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-72x72.png to #> favicons/swc/apple-touch-icon-72x72.png #> Copying #> <varnish>/pkgdown/assets/favicons/swc/apple-touch-icon-76x76.png to #> favicons/swc/apple-touch-icon-76x76.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-128.png to #> favicons/swc/favicon-128.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-16x16.png to #> favicons/swc/favicon-16x16.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-196x196.png to #> favicons/swc/favicon-196x196.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-32x32.png to #> favicons/swc/favicon-32x32.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon-96x96.png to #> favicons/swc/favicon-96x96.png #> Copying <varnish>/pkgdown/assets/favicons/swc/favicon.ico to #> favicons/swc/favicon.ico #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-144x144.png to #> favicons/swc/mstile-144x144.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-150x150.png to #> favicons/swc/mstile-150x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x150.png to #> favicons/swc/mstile-310x150.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-310x310.png to #> favicons/swc/mstile-310x310.png #> Copying <varnish>/pkgdown/assets/favicons/swc/mstile-70x70.png to #> favicons/swc/mstile-70x70.png #> Copying <varnish>/pkgdown/assets/mstile-150x150.png to #> mstile-150x150.png #> Copying <varnish>/pkgdown/assets/safari-pinned-tab.svg to #> safari-pinned-tab.svg #> Copying <varnish>/pkgdown/assets/site.webmanifest to site.webmanifest dir(file.path(tmp, \"site\")) #> [1] \"DESCRIPTION\" \"README.md\" \"_pkgdown.yaml\" \"built\" #> [5] \"docs\" reset_site(tmp) dir(file.path(tmp, \"site\")) #> [1] \"DESCRIPTION\" \"README.md\" \"_pkgdown.yaml\" \"built\""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper-package.html","id":null,"dir":"Reference","previous_headings":"","what":"sandpaper: Create and Curate Carpentries Lessons — sandpaper-package","title":"sandpaper: Create and Curate Carpentries Lessons — sandpaper-package","text":"provide tools build Carpentries-themed lesson repository accessible standalone static website. include local tools designed used continuous integration context lesson author needs focus writing content actual lesson.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"sandpaper: Create and Curate Carpentries Lessons — sandpaper-package","text":"Maintainer: Robert Davey robertdavey@carpentries.org (ORCID) Authors: Erin Becker erinbecker@carpentries.org (ORCID) Zhian N. Kamvar zkamvar@carpentries.org (ORCID) Joel H. Nitta joelnitta@gmail.com (ORCID) [translator] contributors: Julien Colomb (ORCID) [contributor] Ben Companjen (ORCID) [contributor] Toby Hodges tobyhodges@carpentries.org [contributor] François Michonneau francois@carpentries.org [contributor] Kelly Barnes kbarnes@carpentries.org [contributor] Hugo Gruson hugo.gruson+R@normalesup.org [contributor] Milan Malfait milan.malfait94@gmail.com (ORCID) [contributor] Yanina Bellini Saibene (ORCID) [contributor, translator]","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper.options.html","id":null,"dir":"Reference","previous_headings":"","what":"Global Options — sandpaper.options","title":"Global Options — sandpaper.options","text":"documentation options","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper.options.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Global Options — sandpaper.options","text":"2022-02-22, several options used sandpaper may manipulated user. set may change future, description options set startup:","code":"option(\"sandpaper.show_draft\" = TRUE) option(\"sandpaper.links\" = NULL) option(\"sandpaper.use_renv\" = FALSE) option(\"sandpaper.package_cache_trigger\" = FALSE) option(\"sandpaper.test_fixture\" = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper.options.html","id":"sandpaper-show-draft","dir":"Reference","previous_headings":"","what":"sandpaper.show_draft","title":"Global Options — sandpaper.options","text":"Default: TRUE user messages. TRUE, message episodes draft status (.e. episodes folder, schedule) printed get_drafts(). Setting option FALSE turn feature.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper.options.html","id":"sandpaper-links","dir":"Reference","previous_headings":"","what":"sandpaper.links","title":"Global Options — sandpaper.options","text":"Default: NULL option provides way override default place links sandpaper lesson. NULL file called links.md top repository, appended bottom page rendered HTML.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper.options.html","id":"sandpaper-use-renv","dir":"Reference","previous_headings":"","what":"sandpaper.use_renv","title":"Global Options — sandpaper.options","text":"Default: variable option modified user. determines {renv} used locally R-based lessons. set use_package_cache() unset no_package_cache(). local user never consented using {renv} previously, defaults FALSE, {renv} previously used, TRUE.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper.options.html","id":"sandpaper-package-cache-trigger","dir":"Reference","previous_headings":"","what":"sandpaper.package_cache_trigger","title":"Global Options — sandpaper.options","text":"Default: FALSE locally/TRUE GitHub tells R Markdown lessons rebuild everything {renv} lockfile changes.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper.options.html","id":"sandpaper-test-fixture","dir":"Reference","previous_headings":"","what":"sandpaper.test_fixture","title":"Global Options — sandpaper.options","text":"Default: NULL internal use testing interactive components non-interactively setting {renv} behave correctly testing.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Site generator for sandpaper — sandpaper_site","title":"Site generator for sandpaper — sandpaper_site","text":"custom site generator compatibility rmarkdown::site_generator(). RStudio users, placing index.md yaml header make knit button work:","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Site generator for sandpaper — sandpaper_site","text":"","code":"sandpaper_site(input = \".\", ...)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/sandpaper_site.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Site generator for sandpaper — sandpaper_site","text":"automatically added index.md sandpaper sites version 0.0.0.9013, maintainers need worry . Thanks goes Yihui Xie coming concept modular site generators JJ Alaire allowing sub-directory structures RMarkdown sites.","code":"site: sandpaper::sandpaper_site"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/serve.html","id":null,"dir":"Reference","previous_headings":"","what":"Build your lesson and work on it at the same time — serve","title":"Build your lesson and work on it at the same time — serve","text":"function serve lesson auto-update whenever save file.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/serve.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build your lesson and work on it at the same time — serve","text":"","code":"serve(path = \".\", quiet = !interactive(), ...)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/serve.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build your lesson and work on it at the same time — serve","text":"path path lesson. Defaults current path. quiet TRUE, messages printed output. Defaults FALSE non-interactive sessions, allows messages printed. ... options passed servr::server_config() way servr::httw(). can include port host configuration.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/serve.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build your lesson and work on it at the same time — serve","text":"output servr::httw(), invisibly. mainly used side-effect","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/serve.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build your lesson and work on it at the same time — serve","text":"sandpaper::serve() entry point working lesson using Carpentries Workbench. run function interactively, preview window open either RStudio browser address like localhost:4321 (note number likely different). make changes files lesson, preview update automatically. done preview, can run servr::daemon_stop().","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/serve.html","id":"command-line-usage","dir":"Reference","previous_headings":"","what":"Command line usage","title":"Build your lesson and work on it at the same time — serve","text":"can use command line use RStudio another IDE acts web browser. run command line, use: Note unlike interactive session, progress messages printed (except accessibility checks) browser window automatically launch. can messages print screen quiet = FALSE argument. addition, want specify port host function, can using port host arguments:","code":"R -e 'sandpaper::serve()' R -e 'sandpaper::serve(quiet = FALSE, host = \"127.0.0.1\", port = \"3435\")'"},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/serve.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build your lesson and work on it at the same time — serve","text":"","code":"if (FALSE) { # create an example lesson tmp <- tempfile() create_lesson(tmp, open = FALSE) # open the episode for editing file.edit(fs::path(tmp, \"episodes\", \"01-introduction.Rmd\")) # serve the lesson and begin editing the file. Watch how the file will # auto-update whenever you save it. sandpaper::serve() # # to stop the server, run servr::daemon_stop() # # If you want to use a different port, you can specify it directly sandpaper::serve(host = \"127.0.0.1\", port = \"3435\") }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":null,"dir":"Reference","previous_headings":"","what":"Set individual keys in a configuration file — set_config","title":"Set individual keys in a configuration file — set_config","text":"Set individual keys configuration file","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set individual keys in a configuration file — set_config","text":"","code":"set_config(pairs = NULL, create = FALSE, path = \".\", write = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set individual keys in a configuration file — set_config","text":"pairs named list character vector keys names new values contents create TRUE, new values pairs created appended; defaults FALSE, prevents typos sneaking . single key-pair values currently supported. path path lesson. Defaults current directory. write TRUE, schedule overwrite schedule current file.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Set individual keys in a configuration file — set_config","text":"function deals strictly keypairs yaml. lists, see set_dropdown().","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":"default-keypairs-known-by-sandpaper","dir":"Reference","previous_headings":"","what":"Default Keypairs Known by Sandpaper","title":"Set individual keys in a configuration file — set_config","text":"create new lesson sandpaper, set default keypairs pre-filled. make sure contact information links footer accurate, please modify values. carpentry [character] one cp, dc, swc, lab, incubator title [character] lesson title (e.g. 'Introduction R Plant Pathologists' created [character] Date ISO 8601 format (e.g. '2021-02-09') keywords [character] comma-separated list (e.g 'static site, R, tidyverse') life_cycle [character] one pre-alpha, alpha, beta, stable license [character] license lesson (e.g. 'CC-4.0') source [character] source repository URL branch [character] default branch (e.g. 'main') contact [character] email address contact information lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":"optional-keypairs-known-by-sandpaper","dir":"Reference","previous_headings":"","what":"Optional Keypairs Known by Sandpaper","title":"Set individual keys in a configuration file — set_config","text":"following keypairs known sandpaper, optional: lang [character] language code matches language lesson content. defaults \"en\", can language code (e.g. \"ja\" specifying Japanese) combination language code country code (e.g. \"pt_BR\" specifies Pourtugese used Brazil). information used, see Locale Names section gettext manual url [character] custom URL deploying URL default github pages io domain. fail_on_error [boolean] R Markdown lessons; fail build chunks produce error. Use #| error: true chunk options allow error displayed workbench-beta [boolean] truthy, displays banner site indicates site workbench beta phase. overview [boolean] lessons must episodes exception overview lessons. indicate lesson serves overview lessons, use overview: true handout [boolean] [character] option instructs {sandpaper} create handout RMarkdown files via {pegboard}, uses knitr::purl() background removing everything challenges (without solutions) code blocks purl = TRUE. default path handout files/code-handout.R workbench becomes developed, optional keys may disappear.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":"custom-engines","dir":"Reference","previous_headings":"","what":"Custom Engines","title":"Set individual keys in a configuration file — set_config","text":"use specific version sandpaper varnish locally, install using remotes::install_github(\"carpentries/sandpaper@VERSION\") syntax, provision versions GitHub, can provision config.yaml file: sandpaper [character] github string version number sandpaper version use varnish [character] github string version number varnish version use pegboard [character] github string version number pegboard version use example, forked version varnish modify colourscheme, use: specific branch sandpaper varnish tested, want test lesson temporarily, use @ symbol refer specific branch commit use:","code":"varnish: MYACCOUNT/varnish sandpaper: carpentries/sandpaper@BRANCH-NAME varnish: carpentries/varnish@BRANCH-name"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_config.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set individual keys in a configuration file — set_config","text":"","code":"if (FALSE) { tmp <- tempfile() create_lesson(tmp, \"test lesson\", open = FALSE, rmd = FALSE) # Change the title and License (default vars) set_config(c(title = \"Absolutely Free Lesson\", license = \"CC0\"), path = tmp, write = TRUE ) # add the URL and workbench-beta indicator set_config(list(\"workbench-beta\" = TRUE, url = \"https://example.com/\"), path = tmp, create = TRUE, write = TRUE ) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_dropdown.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the order of items in a dropdown menu — set_dropdown","title":"Set the order of items in a dropdown menu — set_dropdown","text":"Set order items dropdown menu","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_dropdown.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the order of items in a dropdown menu — set_dropdown","text":"","code":"set_dropdown(path = \".\", order = NULL, write = FALSE, folder) set_episodes(path = \".\", order = NULL, write = FALSE) set_learners(path = \".\", order = NULL, write = FALSE) set_instructors(path = \".\", order = NULL, write = FALSE) set_profiles(path = \".\", order = NULL, write = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_dropdown.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the order of items in a dropdown menu — set_dropdown","text":"path path lesson. Defaults current directory. order files order presented (extension) write TRUE, schedule overwrite schedule current file. folder one four folders sandpaper recognises files listed order located: episodes, learners, instructors, profiles.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_dropdown.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set the order of items in a dropdown menu — set_dropdown","text":"","code":"tmp <- tempfile() create_lesson(tmp, \"test lesson\", open = FALSE, rmd = FALSE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062cb0065e... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062cb0065e... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062cb0065e... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062cb0065e... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062cb0065e... #> ☐ Edit /tmp/RtmpQSXDNq/file17062cb0065e/episodes/introduction.md. #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062cb0065e... #> ✔ First episode created in /tmp/RtmpQSXDNq/file17062cb0065e/episodes/introduction.md #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062cb0065e... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062cb0065e... #> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file17062cb0065e #> → Creating Lesson in /tmp/RtmpQSXDNq/file17062cb0065e... #> /tmp/RtmpQSXDNq/file17062cb0065e # Change the title and License set_config(c(title = \"Absolutely Free Lesson\", license = \"CC0\"), path = tmp, write = TRUE ) #> ℹ Writing to /tmp/RtmpQSXDNq/file17062cb0065e/config.yaml #> → title: 'test lesson' -> title: 'Absolutely Free Lesson' #> → license: 'CC-BY 4.0' -> license: 'CC0' create_episode(\"using-R\", path = tmp, open = FALSE) #> ☐ Edit /tmp/RtmpQSXDNq/file17062cb0065e/episodes/using-r.Rmd. #> /tmp/RtmpQSXDNq/file17062cb0065e/episodes/using-r.Rmd print(sched <- get_episodes(tmp)) #> [1] \"introduction.md\" \"using-r.Rmd\" # reverse the schedule set_episodes(tmp, order = rev(sched)) #> episodes: #> - using-r.Rmd #> - introduction.md #> #> ──────────────────────────────────────────────────────────────────────── #> ℹ To save this configuration, use #> #> set_episodes(path = tmp, order = rev(sched), write = TRUE) # write it set_episodes(tmp, order = rev(sched), write = TRUE) # see it get_episodes(tmp) #> [1] \"using-r.Rmd\" \"introduction.md\""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_globals.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the necessary common global variables for use in the {varnish} template. — set_globals","title":"Set the necessary common global variables for use in the {varnish} template. — set_globals","text":"enforce four global lists:","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_globals.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the necessary common global variables for use in the {varnish} template. — set_globals","text":"","code":"set_globals(path)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_globals.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the necessary common global variables for use in the {varnish} template. — set_globals","text":"path path lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/set_globals.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Set the necessary common global variables for use in the {varnish} template. — set_globals","text":".resources, equivalent output get_resource_list() this_metadata, contains metadata common lesson learner_globals navigation items learners instructor_globals namvigation items instructors things added: sidebar generated create_sidebar() learner instructor globals exception first element. \"\" dropdown menu, created via create_resources_dropdown(). resources \"\", positioned mobile sidebar. {sandpaper,varnish,pegboard}_version package versions package.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/strip_prefix.html","id":null,"dir":"Reference","previous_headings":"","what":"This will strip existing episode prefixes and set the schedule — strip_prefix","title":"This will strip existing episode prefixes and set the schedule — strip_prefix","text":"Episode order Carpentries lessons originally used strategy prefixing files two-digit number force specific order filename. function strip numbers filename set schedule according original order.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/strip_prefix.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"This will strip existing episode prefixes and set the schedule — strip_prefix","text":"","code":"strip_prefix(path = \".\", write = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/strip_prefix.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"This will strip existing episode prefixes and set the schedule — strip_prefix","text":"path path lesson (defaults current working directory) write defaults FALSE, show potential changes. TRUE, schedule modified written config.yaml","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/strip_prefix.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"This will strip existing episode prefixes and set the schedule — strip_prefix","text":"write = TRUE, modified list episodes. write = FALSE, modified call returned.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/strip_prefix.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"This will strip existing episode prefixes and set the schedule — strip_prefix","text":"git recognise deleting file adding new file stage. run git add, recognise rename.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/strip_prefix.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"This will strip existing episode prefixes and set the schedule — strip_prefix","text":"","code":"if (FALSE) { strip_prefix() # test if the function is doing what you want it to do strip_prefix(write = TRUE) # rewrite the episode names }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/template.html","id":null,"dir":"Reference","previous_headings":"","what":"Template files — template_gitignore","title":"Template files — template_gitignore","text":"Use files templates sandpaper lesson","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/template.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Template files — template_gitignore","text":"","code":"template_gitignore() template_episode() template_links() template_citation() template_config() template_conduct() template_index() template_license() template_contributing() template_setup() template_pkgdown() template_placeholder() template_pr_diff() template_sidebar_item() template_metadata()"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/template.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Template files — template_gitignore","text":"character string path template within {sandpaper} repo.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/template.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Template files — template_gitignore","text":"","code":"cat(readLines(template_gitignore(), n = 6), sep = \"\\n\") #> # sandpaper files #> episodes/*html #> site/* #> !site/README.md #> #> # History files"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":null,"dir":"Reference","previous_headings":"","what":"Establish and Manage Translation Strings — these","title":"Establish and Manage Translation Strings — these","text":"documentation internal functions translation. want guide providing translations, please read vignette(\"translations\", package = \"sandpaper\")","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Establish and Manage Translation Strings — these","text":"","code":"these establish_translation_vars() set_language(lang = NULL) tr_src(from = \"varnish\", key = NULL) tr_get(from = \"varnish\", key = NULL) tr_varnish(key = NULL) tr_computed(key = NULL)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Establish and Manage Translation Strings — these","text":"object class environment length 1.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Establish and Manage Translation Strings — these","text":"lang two-letter language code (optionally country code). Defaults NULL, falls back English (language source code). single character specifying translation list fetch. defaults \"varnish\" can one following: src varnish computed key single character specifying specific key fetch translation list. defaults NULL, returning whole list.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Establish and Manage Translation Strings — these","text":"key = NULL, list key single character, result unnamed character vector length 1 representing value list.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Establish and Manage Translation Strings — these","text":"page generated {sandpaper} made user-provided content wrapped templated HTML provided {varnish}. Since users can provide content human language can processed computer, {sandpaper} must method match template content language content. translations added source {sandpaper} volunteers using {potools} package. Template content strings stored $translations element global environment variable, generated establish_translation_vars() function, run every time {sandpaper} loaded. $translations element consists three lists: varnish: list translated strings passed directly {varnish} computed: list translated strings incorporated HTML content passed {varnish}. src: source list two lists serves source translations. Whenever lesson built, function set_language() read lang item config.yaml apply translations $translations$varnish $translations$computed lesson generated updated.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":"list-of-translation-variables","dir":"Reference","previous_headings":"","what":"List of Translation Variables","title":"Establish and Manage Translation Strings — these","text":"62 translations generated set_language() correspond following variables {varnish}: addition, 26 translations inserted get {varnish}:","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/translations.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Establish and Manage Translation Strings — these","text":"","code":"# When sandpaper is loaded, these functions return English snd <- asNamespace(\"sandpaper\") head(snd$tr_varnish()) #> $SkipToMain #> [1] \"Skip to main content\" #> #> $iPreAlpha #> [1] \"Pre-Alpha\" #> #> $PreAlphaNote #> [1] \"This lesson is in the pre-alpha phase, which means that it is in early development, but has not yet been taught.\" #> #> $AlphaNote #> [1] \"This lesson is in the alpha phase, which means that it has been taught once and lesson authors are iterating on feedback.\" #> #> $iAlpha #> [1] \"Alpha\" #> #> $BetaNote #> [1] \"This lesson is in the beta phase, which means that it is ready for teaching by instructors outside of the original author team.\" #> head(snd$tr_computed()) #> $OUTPUT #> [1] \"OUTPUT\" #> #> $WARNING #> [1] \"WARNING\" #> #> $ERROR #> [1] \"ERROR\" #> #> $Overview #> [1] \"Overview\" #> #> $Questions #> [1] \"Questions\" #> #> $Objectives #> [1] \"Objectives\" #> # Setting language to Spanish will translate the computed and varnish snd$set_language(\"es\") head(snd$tr_varnish()) #> $SkipToMain #> [1] \"Ir al contenido principal\" #> #> $iPreAlpha #> [1] \"Pre-Alfa\" #> #> $PreAlphaNote #> [1] \"Esta lección se encuentra en la fase pre-alfa, lo que significa que está en las primeras etapas de desarrollo, pero aún no se ha enseñado.\" #> #> $AlphaNote #> [1] \"Esta lección se encuentra en la fase alfa, lo que significa que se ha enseñado una vesy las autoras de la lección están trabajando en los comentarios.\" #> #> $iAlpha #> [1] \"Alfa\" #> #> $BetaNote #> [1] \"Esta lección se encuentra en la fase beta, lo que significa que está lista para enseñarpor instructoras que no son parte del equipo original de autoras\" #> head(snd$tr_computed()) #> $OUTPUT #> [1] \"SALIDA\" #> #> $WARNING #> [1] \"ADVERTENCIA\" #> #> $ERROR #> [1] \"ERROR\" #> #> $Overview #> [1] \"Hoja de ruta\" #> #> $Questions #> [1] \"Preguntas\" #> #> $Objectives #> [1] \"Objetivos\" #> # The source will remain the same head(snd$tr_src(\"varnish\")) #> $SkipToMain #> [1] \"Skip to main content\" #> #> $iPreAlpha #> [1] \"Pre-Alpha\" #> #> $PreAlphaNote #> [1] \"This lesson is in the pre-alpha phase, which means that it is in early development, but has not yet been taught.\" #> #> $AlphaNote #> [1] \"This lesson is in the alpha phase, which means that it has been taught once and lesson authors are iterating on feedback.\" #> #> $iAlpha #> [1] \"Alpha\" #> #> $BetaNote #> [1] \"This lesson is in the beta phase, which means that it is ready for teaching by instructors outside of the original author team.\" #> head(snd$tr_src(\"computed\")) #> $OUTPUT #> [1] \"OUTPUT\" #> #> $WARNING #> [1] \"WARNING\" #> #> $ERROR #> [1] \"ERROR\" #> #> $Overview #> [1] \"Overview\" #> #> $Questions #> [1] \"Questions\" #> #> $Objectives #> [1] \"Objectives\" #> # Running set_language with no arguments defaults to English snd$set_language() head(snd$tr_varnish()) #> $SkipToMain #> [1] \"Skip to main content\" #> #> $iPreAlpha #> [1] \"Pre-Alpha\" #> #> $PreAlphaNote #> [1] \"This lesson is in the pre-alpha phase, which means that it is in early development, but has not yet been taught.\" #> #> $AlphaNote #> [1] \"This lesson is in the alpha phase, which means that it has been taught once and lesson authors are iterating on feedback.\" #> #> $iAlpha #> [1] \"Alpha\" #> #> $BetaNote #> [1] \"This lesson is in the beta phase, which means that it is ready for teaching by instructors outside of the original author team.\" #> head(snd$tr_computed()) #> $OUTPUT #> [1] \"OUTPUT\" #> #> $WARNING #> [1] \"WARNING\" #> #> $ERROR #> [1] \"ERROR\" #> #> $Overview #> [1] \"Overview\" #> #> $Questions #> [1] \"Questions\" #> #> $Objectives #> [1] \"Objectives\" #>"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/try_use_renv.html","id":null,"dir":"Reference","previous_headings":"","what":"Try to use {renv} — try_use_renv","title":"Try to use {renv} — try_use_renv","text":"use sandpaper starts see user previously consented {renv}. problem renv::consent() throws TRUE user consented error :(","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/try_use_renv.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Try to use {renv} — try_use_renv","text":"","code":"try_use_renv(force = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/try_use_renv.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Try to use {renv} — try_use_renv","text":"force TRUE, consent forced TRUE, creating cache directory exist . Defaults FALSE, gently inquires consent.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/try_use_renv.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Try to use {renv} — try_use_renv","text":"character vector","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/try_use_renv.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Try to use {renv} — try_use_renv","text":"function wraps renv::consent() callr function transforms error FALSE. sets sandpaper.use_renv variable value check returns full text output FALSE (WELCOME message given someone uses {renv} first time) last line output TRUE (message either directory created consent already provided.)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_github_workflows.html","id":null,"dir":"Reference","previous_headings":"","what":"Update github workflows — update_github_workflows","title":"Update github workflows — update_github_workflows","text":"function copies updates workflows run {sandpaper}.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_github_workflows.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update github workflows — update_github_workflows","text":"","code":"update_github_workflows( path = \".\", files = \"\", overwrite = TRUE, clean = \"*.yaml\", quiet = FALSE )"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_github_workflows.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update github workflows — update_github_workflows","text":"path path current lesson. files files include update. Defaults empty string, update files overwrite TRUE (default), file(s) overwritten. clean glob files cleaned writing. Defaults \"*.yaml\". remove files four-letter \"yaml\" extension (remove \".yml\" extension). can also specify whole file name like \"workflow.yaml\" remove one specific file. want clean, set NULL. quiet TRUE, process output messages, default FALSE, report progress step.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_github_workflows.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update github workflows — update_github_workflows","text":"paths new files.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_varnish.html","id":null,"dir":"Reference","previous_headings":"","what":"Update the local version of the carpentries style — update_varnish","title":"Update the local version of the carpentries style — update_varnish","text":"Update local version carpentries style","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_varnish.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update the local version of the carpentries style — update_varnish","text":"","code":"update_varnish(version = NULL, ...)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_varnish.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update the local version of the carpentries style — update_varnish","text":"version NULL, update latest version, otherwise, can version string identify specific version use. ... arguments passed utils::install.packages()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_varnish.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update the local version of the carpentries style — update_varnish","text":"NULL, invisibly","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/update_varnish.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Update the local version of the carpentries style — update_varnish","text":"requires internet connection","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":null,"dir":"Reference","previous_headings":"","what":"Pre-build validation of lesson elements — validate_lesson","title":"Pre-build validation of lesson elements — validate_lesson","text":"validator based pegboard::Lesson class cached this_lesson() provide line reports fenced divs, links, images, heading structure. details type validators avaliable, see {pegboard} article Validation Lesson Elements","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pre-build validation of lesson elements — validate_lesson","text":"","code":"validate_lesson(path = \".\", headings = FALSE, quiet = FALSE)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pre-build validation of lesson elements — validate_lesson","text":"path path lesson. Defaults ot current directory headings TRUE, headings checked validated. Currently set FALSE re-investigating false positives. quiet TRUE, messages issued, otherwise progress messages issued test","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pre-build validation of lesson elements — validate_lesson","text":"list results test described pegboard::Lesson","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":"headings","dir":"Reference","previous_headings":"","what":"Headings","title":"Pre-build validation of lesson elements — validate_lesson","text":"expect headings semantic informative. Details tests headings can found pegboard::validate_headings()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":"internal-links-and-images","dir":"Reference","previous_headings":"","what":"Internal Links and Images","title":"Pre-build validation of lesson elements — validate_lesson","text":"Internal links images exist images alt text. Details tests can found pegboard::validate_links()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":"fenced-divs-callout-blocks-","dir":"Reference","previous_headings":"","what":"Fenced Divs (callout blocks)","title":"Pre-build validation of lesson elements — validate_lesson","text":"Callout Blocks one expected types. Details test can found pegboard::validate_divs()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/validate_lesson.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Pre-build validation of lesson elements — validate_lesson","text":"","code":"tmp <- tempfile() lsn <- create_lesson(tmp, open = FALSE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706736d1e51... #> ℹ No schedule set, using Rmd files in episodes/ directory. #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706736d1e51... #> → To remove this message, define your schedule in config.yaml or use `set_episodes()` to generate it. #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706736d1e51... #> ──────────────────────────────────────────────────────────────────────── #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706736d1e51... #> ℹ To save this configuration, use #> #> set_episodes(path = path, order = ep, write = TRUE) #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706736d1e51... #> ☐ Edit /tmp/RtmpQSXDNq/file1706736d1e51/episodes/introduction.Rmd. #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706736d1e51... #> ✔ First episode created in /tmp/RtmpQSXDNq/file1706736d1e51/episodes/introduction.Rmd #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706736d1e51... #> ℹ Workflows up-to-date! #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706736d1e51... #> ℹ Consent to use package cache provided #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706736d1e51... #> - The project is out-of-sync -- use `renv::status()` for details. #> → Searching for and installing available dependencies #> The following packages were discovered: #> #> # ~/work/_temp/Library ------------------------------------------------------- #> - R6 2.5.1 #> - base64enc 0.1-3 #> - bslib 0.8.0 #> - cachem 1.1.0 #> - cli 3.6.3 #> - digest 0.6.37 #> - evaluate 1.0.1 #> - fastmap 1.2.0 #> - fontawesome 0.5.2 #> - fs 1.6.5 #> - glue 1.8.0 #> - highr 0.11 #> - htmltools 0.5.8.1 #> - jquerylib 0.1.4 #> - jsonlite 1.8.9 #> - knitr 1.48 #> - lifecycle 1.0.4 #> - memoise 2.0.1 #> - mime 0.12 #> - rappdirs 0.3.3 #> - rlang 1.1.4 #> - rmarkdown 2.29 #> - sass 0.4.9 #> - tinytex 0.54 #> - xfun 0.49 #> - yaml 2.3.10 #> #> They will be copied into the project library. #> #> - Copying packages into the project library ... Done! #> - Hydrated 26 packages in 0.21 seconds. #> - The project is out-of-sync -- use `renv::status()` for details. #> → Recording changes in lockfile #> The following package(s) will be updated in the lockfile: #> #> # https://packagemanager.posit.co/cran/__linux__/jammy/latest ---------------- #> - R6 [* -> 2.5.1] #> - base64enc [* -> 0.1-3] #> - bslib [* -> 0.8.0] #> - cachem [* -> 1.1.0] #> - cli [* -> 3.6.3] #> - digest [* -> 0.6.37] #> - evaluate [* -> 1.0.1] #> - fastmap [* -> 1.2.0] #> - fontawesome [* -> 0.5.2] #> - fs [* -> 1.6.5] #> - glue [* -> 1.8.0] #> - highr [* -> 0.11] #> - htmltools [* -> 0.5.8.1] #> - jquerylib [* -> 0.1.4] #> - jsonlite [* -> 1.8.9] #> - knitr [* -> 1.48] #> - lifecycle [* -> 1.0.4] #> - memoise [* -> 2.0.1] #> - mime [* -> 0.12] #> - rappdirs [* -> 0.3.3] #> - renv [* -> 1.0.11] #> - rlang [* -> 1.1.4] #> - rmarkdown [* -> 2.29] #> - sass [* -> 0.4.9] #> - tinytex [* -> 0.54] #> - xfun [* -> 0.49] #> - yaml [* -> 2.3.10] #> #> The version of R recorded in the lockfile will be updated: #> - R [* -> 4.4.2] #> #> - Lockfile written to \"/tmp/RtmpQSXDNq/file1706736d1e51/renv/profiles/lesson-requirements/renv.lock\". #> ✔ Lesson successfully created in /tmp/RtmpQSXDNq/file1706736d1e51 #> → Creating Lesson in /tmp/RtmpQSXDNq/file1706736d1e51... validate_lesson(lsn, headings = TRUE) #> ── Validating Headings ───────────────────────────────────────────────── #> ── Validating Fenced Divs ────────────────────────────────────────────── #> ── Validating Internal Links and Images ────────────────────────────────"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/work_with_cache.html","id":null,"dir":"Reference","previous_headings":"","what":"(Experimental) Work with the package cache — work_with_cache","title":"(Experimental) Work with the package cache — work_with_cache","text":"function designed can work lesson inside package cache without overwriting personal library.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/work_with_cache.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"(Experimental) Work with the package cache — work_with_cache","text":"","code":"work_with_cache(profile = \"lesson-requirements\")"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/work_with_cache.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"(Experimental) Work with the package cache — work_with_cache","text":"function reset R environment original state","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/work_with_cache.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"(Experimental) Work with the package cache — work_with_cache","text":"","code":"if (interactive() && fs::dir_exists(\"episodes\")) { library(\"sandpaper\") done <- work_with_cache() print(.libPaths()) # install.packages(\"cowsay\") # install cowsay to your lesson cache # cowsay::say() # hello world # detach('package:cowsay') # detach the package from your current session done() # finish the session # try(cowsay::say()) # this fails because it's not in your global library print(.libPaths()) }"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/yaml_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a valid, opinionated yaml list for insertion into a whisker template — yaml_list","title":"Create a valid, opinionated yaml list for insertion into a whisker template — yaml_list","text":"Create valid, opinionated yaml list insertion whisker template","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/yaml_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a valid, opinionated yaml list for insertion into a whisker template — yaml_list","text":"","code":"yaml_list(thing)"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/yaml_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a valid, opinionated yaml list for insertion into a whisker template — yaml_list","text":"thing vector list","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/yaml_list.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a valid, opinionated yaml list for insertion into a whisker template — yaml_list","text":"character vector want manipulate config file command line preserve comments. Unfortunately, yaml C library parse comments makes things difficult handle. moment hack use whisker templates , drawback whisker know handle lists, concatenates commas: Moreover, want indicate yaml list single key/value pair want enforce converts elements yaml list enters whisker makes sure values clearly lists.","code":"x <- c(\"a\", \"b\", \"c\") hx <- list(hello = x) cat(yaml::as.yaml(hx)) # representation in yaml #> hello: #> - a #> - b #> - c cat(whisker::whisker.render(\"hello: {{hello}}\", hx)) # messed up whisker #> hello: a,b,c key: - value1 key: value1 hx[[\"hello\"]] <- sandpaper:::yaml_list(hx[[\"hello\"]]) cat(whisker::whisker.render(\"hello: {{hello}}\", hx)) # good whisker #> hello: #> - a #> - b #> - c"},{"path":"https://carpentries.github.io/sandpaper/dev/reference/yaml_list.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Create a valid, opinionated yaml list for insertion into a whisker template — yaml_list","text":"better solution hack, now, keep okay purposes: https://github.com/rstudio/blogdown/issues/560","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/reference/yaml_list.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a valid, opinionated yaml list for insertion into a whisker template — yaml_list","text":"","code":"x <- c(\"a\", \"b\", \"c\") hx <- list(hello = x) cat(yaml::as.yaml(hx)) # representation in yaml #> hello: #> - a #> - b #> - c cat(whisker::whisker.render(\"hello: {{hello}}\", hx)) # messed up whisker #> hello: a,b,c hx[[\"hello\"]] <- sandpaper:::yaml_list(hx[[\"hello\"]]) cat(whisker::whisker.render(\"hello: {{hello}}\", hx)) # good whisker #> hello: #> - a #> - b #> - c"},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-16-9","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.16.9 (2024-10-15)","text":"Pin remaining workflows ubuntu-22.04 instead ubuntu-latest (@froggleston #610) Add compiled potools translation German","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-16-8","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.16.8 (2024-10-11)","text":"Pin workflow ubuntu-22.04 instead ubuntu-latest (reported @chrbknudsen #605, fixed @froggleston #606) Update notes remove excessive build warnings (@milanmlft #599)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"languages-0-16-8","dir":"Changelog","previous_headings":"","what":"LANGUAGES","title":"sandpaper 0.16.8 (2024-10-11)","text":"Add R-de.po German translations lesson elements (@martin-raden #607)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-16-8","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.16.8 (2024-10-11)","text":"Added @martin-raden contributor translator - welcome!","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-16-7","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.16.7 (2024-09-04)","text":"Add overwrite option pr workflow fix change default update-artifact action v3 v4 (@milanmlft #602)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-16-6","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.16.6 (2024-08-23)","text":"Regression fix update pkgdown resulting duplicated untranslated h2 anchors sections (@froggleston #600) Fix various action warnings issues relating old Node.js versions (@jhlegarreta #596) Update core actions v4 (@Bisaloo #577)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-16-6","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.16.6 (2024-08-23)","text":"Allow custom carpentry config types, associated alt-text descriptions support alternative logos/theming lessons (@milanmlft #585, @ErinBecker) Add support French translations core lesson components/sections (@Bisaloo #595)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-16-5","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.16.5 (2024-06-18)","text":"Fix empty divs checking headers (reported: @dmgatti, #581; fixed @froggleston) Fix spacing callout titles inner tags, e.g. <code> (reported: @abostroem, #562; fixed @froggleston)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-16-5","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.16.5 (2024-06-18)","text":"Add support including Carpentries matomo tracker, custom user-supplied tracker script, tracking (reported: @tbyhdgs, @fiveop https://github.com/carpentries/varnish/issues/37, @zkamvar https://github.com/carpentries/sandpaper/issues/438, implemented: @froggleston )","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-16-4","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.16.4 (2024-04-10)","text":"lesson page footer now supports either CITATION CITATION.cff file (reported: @tobyhodges, implemented: @froggleston, #572; @tobyhodges, https://github.com/carpentries/varnish/pull/122) Add support tabbed content lessons (reported: @astroDimitrios, implemented: @astroDimitrios, @froggleston, https://github.com/carpentries/sandpaper/pull/571, https://github.com/carpentries/varnish/pull/121, https://github.com/carpentries/pegboard/pull/148 ).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-16-3","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.16.3 (2024-03-12)","text":"Hotfix pandoc2--pandoc3 bump resulted CSS deduplication section classes callout blocks (reported: @bencomp, #470; @ndporter https://github.com/carpentries/workbench/issues/81; fixed: @froggleston, #574)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-16-2","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.16.2 (2023-12-19)","text":"JSON metadata now contains inLanguage key.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"documentation-0-16-2","dir":"Changelog","previous_headings":"","what":"DOCUMENTATION","title":"sandpaper 0.16.2 (2023-12-19)","text":"list translatable strings now added vignette(\"translations\", package = \"sandpaper\")","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"internal-0-16-2","dir":"Changelog","previous_headings":"","what":"INTERNAL","title":"sandpaper 0.16.2 (2023-12-19)","text":"Translation strings now unduplicated live single file (R/utils-translate.R). make finding updating strings easier maintainer translators. Translations now live global environment called $translations new documentation page called ?translate contains details translations template elements rendered. tr_src() helper function provides access source strings translations. tr_get(), tr_varnish(), tr_computed() helper functions provide access top lists translated strings. replaced tr_() strings point generation.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-16-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.16.1 (2023-12-14)","text":"Callout headings markup titles longer text duplicated (reported: @zkamvar, #556; fixed: @zkamvar, #557)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-16-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.16.0 (2023-12-13)","text":"now possible build lessons languages English website elements also localised language (reported: @zkamvar, #205, @joelnitta, #544; fixed: @joelnitta @zkamvar, #546). known_languages() function return language codes known {sandpaper}.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"documentation-0-16-0","dir":"Changelog","previous_headings":"","what":"DOCUMENTATION","title":"sandpaper 0.16.0 (2023-12-13)","text":"new vignette vignette(\"translation\", package = \"sandpaper\") describes translation template components works submit new/update translations (added: @zkamvar, #546). new vignette data flow vignette(\"data-flow\", package = \"sandpaper\") describes templating, translations, lesson metadata flows {sandpaper} {varnish} (added: @zkamvar, #553)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-16-0","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.16.0 (2023-12-13)","text":"spelling keypoints now consistent menu item callout blocks (reported: @clarallebot, https://github.com/carpentries/workbench/issues/44; fixed: @zkamvar, #546)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-16-0","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.16.0 (2023-12-13)","text":"{withr} package upgraded import suggested package.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"languages-0-16-0","dir":"Changelog","previous_headings":"","what":"LANGUAGES","title":"sandpaper 0.16.0 (2023-12-13)","text":"Japanese (ja) (added: @joelnitta, #546) Spanish (es) (added: @yabellini, #552)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-16-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.16.0 (2023-12-13)","text":"Added @yabellini contributor translator Added @joelnitta author translator","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-15-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.15.0 (2023-11-29)","text":"Using handout: true config.yaml cause handout generated lesson website /files/code-handout.R. moment, relevant R-based lessons (implemented: @froggleston, #527, reviewed: @zkamvar) supersedes need specifying options(sandpaper.handout = TRUE) Content learners now accessible instructor view. instructor view “” dropdown menu item now links learner view items appended. Note clicking links, user remain instructor view. behaviour may change future iterations (reported: @karenword, #394; fixed: @ErinBecker, #530, reviewed: @zkamvar) create_episode() now open new episodes editing interactive sessions (implemented: @milanmlft, #534, reviewed: @zkamvar) site/ folder now customisable writable directory system setting experimental SANDPAPER_SITE environment variable valid empty folder. useful context Docker containers, file permissions mounted volumes always guaranteed (reported: @fherreazcue #536; implemented: @zkamvar, #537) DOI badges can now displayed paired {varnish} version 0.4.0 adding doi: key config.yaml file either raw DOI URL DOI (reported: @tobyhodges, carpentries/workbench#67; fixed: @tobyhodges, #535).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-15-0","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.15.0 (2023-11-29)","text":"Internal build_status() function: make sure root_path() always points lesson root (reported: @milanmlft, #531; fixed: @milanmlft, #532)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-15-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.15.0 (2023-11-29)","text":"Added @milanmlft contributor","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-14-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.14.1 (2023-11-09)","text":"mailto: links longer prepended URL (reported: @apirogov, #538; fixed: @zkamvar, #539)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-14-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.14.0 (2023-10-02)","text":"internal folders can contain standard files, fig, data folders cautionary note duplicate file names folders cause error. validate_lesson() now reports invalid elements child documents new vignette vignette(\"include-child-documents\", package = \"sandpaper\") demonstrates describes caveats using child documents.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-14-0","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.14.0 (2023-10-02)","text":"overview child files longer built top-level files.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-14-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.14.0 (2023-10-02)","text":"R Markdown episodes nested child documents (grand children beyond) now trigger episode rebuild (fixed: @zkamvar, #513) Child file detection functionality moved {pegboard} package","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-14-0","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.14.0 (2023-10-02)","text":"{pegboard} minimum version now 0.7.0","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-13-3","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.13.3 (2023-09-22)","text":"References heading setup.md now reflected website. (reported: @tobyhodges, @fnattino, @zkamvar, #521; fixed: @ErinBecker @zkamvar, #522). regression #514 empty menus cause failure deployment 404 page fixed (reported: @tobyhodges @zkamvar, #519; fixed: @zkamvar, #520).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-13-2","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.13.2 (2023-09-20)","text":"Users duplicated init.defaultBranch declarations git config longer fail default branch check (reported: @tesaunders, #516; fixed: @zkamvar, #517)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-13-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.13.1 (2023-09-19)","text":"Aggregate pages longer fail episode prefix aggregate page (e.g. images.html longer fail episode starts images-) (reported: @mwhamgenomics, #511; fixed: @zkamvar, #512) 404 page index link point default index page site instead relative index page, result 404 nested links exist (reported: @kaijagahm @zkamvar, #498; fixed @zkamvar, #514)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-13-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.13.0 (2023-09-06)","text":"Overview style lessons episodic content can now processed, analysed, built {sandpaper}. make lesson overview lesson, can add overview: true config.yaml (reported: @zkamvar, https://github.com/carpentries/workbench/issues/65; implemented: @zkamvar, #496) new spoiler class fenced div allow authors specify expandable section content collapsed default. replaces former paradigm using “floating solution” blocks present options installation different platforms. (implemented: @tobyhodges, #502)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-13-0","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.13.0 (2023-09-06)","text":"Internal function root_path() longer fail episodes/ folder exist long one four folders (site/, learners/, instructors/, profiles/) exists (fixed: @zkamvar, #496) set_config() can now properly process logical values true false R Markdown documents modificiations child documents now take account changes child documents (reported @jcolomb, #497; fixed @zkamvar, #498). broken test development version {renv} fixed. change output functionality, user-visible changes (reported: @zkamvar, #484; fixed: @zkamvar, #487). Broken snapshot tests upstream R-devel fixed ensuring version comparisons always use characters numbers (ergonomically weird, whatever) (reported: @zkamvar #487; fixed: @zkamvar #487) Blank instructor notes pages longer fail build (reported: @apirogov, #505; fixed: @klbarnes20, #509) Tests {renv} post 1.0.0 fixed longer run forever interactively (reported: @zkamvar #500; fixed: @zkamvar, #501)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-13-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.13.0 (2023-09-06)","text":"now testing pandoc 2.19.2 continuous integration. discussion list link new lesson contributing template fixed. examples modified use R Markdown lessons unless necessary, reducing output time needed build examples.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-13-0","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.13.0 (2023-09-06)","text":"README file updated fix typo.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-13-0","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.13.0 (2023-09-06)","text":"{pegboard} minimum version now 0.6.0 {varnish} minimum version now 0.3.0","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-12-4","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.12.4 (2023-06-16)","text":"bug walled systems templated pages (e.g. 404) written due permissions issues fixed (reported: @ocaisa, #479; fixed: @zkamvar, #482).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-12-3","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.12.3 (2023-06-01)","text":"bug git credentials accidentally changed lesson built fixed longer querying git author lesson built. (reported: @joelnitta, @velait, @zkamvar, #449; fixed: @zkamvar, #476).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-12-2","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.12.2 (2023-05-29)","text":"bug sidebar non-episode pages extra commas fixed (reported: @zkamvar, #473; fixed: @zkamvar, #474)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-12-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.12.1 (2023-05-26)","text":"current page sidebar longer hides episode number. (reported: @cynthiaftw, https://github.com/carpentries/workbench/issues/42 #432; fixed: @zkamvar, #472) metadata episodes titles containing markup longer include markup metadata (@zkamvar, #472)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-12-1","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.12.1 (2023-05-26)","text":"internal function sandpaper:::check_pandoc() now points correct URL download RStudio, moved migration posit (@zkamvar, #471)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-12-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.12.0 (2023-05-19)","text":"Aggregate instructor notes now headings link back source instructor note (reported: @tobyhodges, #463; fixed: @zkamvar, #468) internal function sandpaper:::render_html() now explicitly sets pandoc version running subprocess. allows lesson developers use {pandoc} package set pandoc versions. (reported: @zkamvar, #465; fixed: @zkamvar, #465)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-12-0","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.12.0 (2023-05-19)","text":"Callout block anchor links now point correct ID block derived title block (opposed generic ID). (reported: @debpaul, https://github.com/datacarpentry/OpenRefine-ecology-lesson/issues/292 @bencomp, #454; fixed: @zkamvar, #467). Inline images longer automatically transform figure blocks (reported: @ostephens, #445; fixed: @zkamvar, #446). bug preventing image links (e.g. MyBinder badges) rendered links images . fixes issue. also helps distinguish inline images figures DOM.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-11-17","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.11.17 (2023-05-16)","text":"sandpaper::serve() gains quiet argument, defaulting TRUE interactive sessions FALSE command line sessions sandpaper::serve() gains ... argument pass options servr::server_config() setting ports hosts (reported: @twrightsman, https://github.com/carpentries/workbench/issues/50 #459; fixed: @zkamvar, #461).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-17","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.17 (2023-05-16)","text":"Break timing now included overall schedule. (reported: @karenword, #437; fixed: @bencomp, #455).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"test-suite-0-11-17","dir":"Changelog","previous_headings":"","what":"TEST SUITE","title":"sandpaper 0.11.17 (2023-05-16)","text":"upstream feature {renv}, forcing silent testing caused expectations fail. fixed specific tests turning verbosity tests (reported: @zkamvar, #457; fixed: @zkamvar, #458)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-16","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.16 (2023-05-05)","text":"failure incrementally build lesson sandpaper::serve() fixed (reported: @zkamvar, #450; fixed: @zkamvar, #451)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-11-16","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.11.16 (2023-05-05)","text":"Lessons markdown documents longer use callr::r() intermediary (reported: @zkamvar, #442, fixed: @zkamvar, #452)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-15","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.15 (2023-04-05)","text":"404 page now proper styling applied site deployed via one ci_ functions (reported: @zkamvar, #430; fixed: @zkamvar, #431). sandpaper::serve() longer error different directory used.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-14","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.14 (2023-04-04)","text":"404 page added (reported: @fmichonneau, #268; fixed: @zkamvar, #429)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-11-14","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.11.14 (2023-04-04)","text":"minimum version {pegboard} set 0.5.1","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"templates-0-11-14","dir":"Changelog","previous_headings":"","what":"TEMPLATES","title":"sandpaper 0.11.14 (2023-04-04)","text":"README, LICENSE, CONTRIBUTING, SETUP templates fixed work {pegboard} version 0.5.1 LICENSE CONTRIBUTING templates now refer Carpentries whole provides correct links community forums.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"workaround-0-11-13","dir":"Changelog","previous_headings":"","what":"WORKAROUND","title":"sandpaper 0.11.13 (2023-03-25)","text":"Fix issue {renv} version 0.17.2 unable provision packages used parent environment. problem environments version {sandpaper} controlled {renv}. (reported: https://github.com/rstudio/renv/issues/1177, @zkamvar; fixed #423, @zkamvar). Note fix applicable {renv} 0.17.2 fixed newer versions {renv}.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-11-12","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.11.12 (2023-03-22)","text":"workflow files now explicit permissions comment pull requests create new branches called. fixes issue new lessons ability preview pull requests update workflows. (reported: #420, @zkamvar; fixed #421, @zkamvar) create-pull-request action now coming fork Carpentries organisation security.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-11-12","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.11.12 (2023-03-22)","text":"typo fixed package cache vignette CONTRIBUTING boilerplate updated fix formatting issues","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-11","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.11 (2023-03-17)","text":"update_cache() now work {renv} version 0.17.1, lost print method renv_updates class (reported: @zkamvar, #415; fixed: @zkamvar, #416 https://github.com/zkamvar/vise/commit/ee4798701a958ee48429980eb970266885f8265b","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-11-11","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.11.11 (2023-03-17)","text":"@jcolomb added contributor DESCRIPTION.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-10","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.10 (2023-03-16)","text":"New lessons now provision learners/resources.md, allow glossary link work (reported: @elichad, #404 @ManonMarchand, https://github.com/carpentries/workbench-template-md/issues/20; fixed: @zkamvar, #410) default CONTRIBUTING file better suited Workbench longer references now-defunct lesson-example repository (reported fixed: @jcolomb, #407)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-9","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.9 (2023-03-14)","text":"Links assets instructor view longer render 404. (reported: @brownsarahm, #404; fixed: @zkamvar, #409)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-11-9","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.11.9 (2023-03-14)","text":"Lessons files spaces names (e.g learning tool) longer fail comment pull request previews (reported: @zkamvar, #399; fixed: @zkamvar, #400)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-8","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.8 (2023-03-09)","text":"Excessive output renv::diagnostics() building R Markdown documents suppressed.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-internal-fixes-0-11-7","dir":"Changelog","previous_headings":"","what":"MISC INTERNAL FIXES","title":"sandpaper 0.11.7 (2023-03-09)","text":"now build {sandpaper} development version {renv} avoid bugs come {renv} version 0.17.0. See #406 details. internal function message_package_cache() longer fails {renv} version 0.17.0.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-feature-0-11-6","dir":"Changelog","previous_headings":"","what":"NEW FEATURE","title":"sandpaper 0.11.6 (2023-02-15)","text":"blank character timing estimates (e.g. XX) now treated unknown estimate 5 minutes used missing element. warning issued listing episodes missing timings. (reported: @zkamvar, #395; fixed: @zkamvar, #396)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-6","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.6 (2023-02-15)","text":"manage_deps() now attempt recover errors “missing” bioconductor packages. Note provisional solution treats BioConductor packages afterthought. full fix {renv} bootstraps BioConductor repositories (reported: @zkamvar, #365 https://github.com/rstudio/renv/issues/1110; fixed: @zkamvar, #397)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-5","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.5 (2023-02-09)","text":"update_cache() pin_version() now find root path lesson checking manipulating dependencies. circumvent issue user accidentally create episodes/renv folder running update_cache() episodes/ directory (discovered: @sarahkaspar; reported: @zkamvar, #391; fixed: @zkamvar, #392).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-4","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.4 (2023-01-26)","text":"setup page always provisioned lessons regardless exists learners: field config.yaml (reported: @zkamvar, #386; fixed: @zkamvar #387).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"pandoc-0-11-4","dir":"Changelog","previous_headings":"","what":"PANDOC","title":"sandpaper 0.11.4 (2023-01-26)","text":"updates {sandaper} used pandoc version 3, longer implements pandoc.Null() constructor Lua filters (reported: @zkamvar, #380; fixed: @zkamvar: #385)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-11-3","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.11.3 (2022-12-16)","text":"Pull Request workflows now automatically cancel several commits sent succession. Specifically, workflows pr-recieve.yaml pr-comment.yaml given separate concurrency parameters based branch name pull request number. concurrencies prevent false alarms found https://github.com/carpentries/lesson-development-training/pull/165#issuecomment-1337182275. (discovered: @anenadic; reported: @zkamvar, #374; fixed: @zkamvar, #376)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-11-2","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.11.2 (2022-12-06)","text":"create_syllabus() function longer uses pkgdown::as_pkgdown() assumes flat file structure creating syllabus. provides fix #371. downlit shim updated modify function bodies preserving function signatures. workflows testing Windows fixed setting git config autocrlf false checkout (thanks @assignUser tip). test coverage workflow updated avoid long build times.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-11-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.11.1 (2022-12-05)","text":"bug deployment GitHub deployments fail due error says “Error: Can’t find DESCRIPTION” fixed (reported: @tobyhodges, #371; fixed, @zkamvar, #372)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-11-1","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.11.1 (2022-12-05)","text":"code inside main build_ functions cleaned . Unused variables removed narrative comments added provide context.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0110-2022-12-01","dir":"Changelog","previous_headings":"","what":"sandpaper 0.11.0 (2022-12-01)","title":"sandpaper 0.11.0 (2022-12-01)","text":"Documentation internal storage objects updated. Page progress indicators reflect estimated percentage progress lesson based timings recorded episode opposed fraction pages (reported: anonymous, #369; fixed @zkamvar, #370).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-10-8","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.10.8 (2022-11-15)","text":"schedule/syllabus timings now displayed XXh XXm clarify scope timing (requested: @tobyhodges, #361; fixed @zkamvar, #363). Documentation automated pull requests updated reflect bots public_repo scope.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-10-8","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.10.8 (2022-11-15)","text":"bug index page title instructor learner view fixed (reported: @tobyhodges, #361; fixed @zkamvar, #366)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-10-7","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.10.7 (2022-11-02)","text":"pandoc now set use default version r-lib/setup-pandoc (time update, version 2.19.2. Workflows update workflows packages now push single branches called update/workflows update/packages, respectively. avoid issue #350 Workflows longer use deprecated set-output command (reported: @zkamvar, #349; fixed @zkamvar, #356) Versions external actions updated include actions/core@1.10.0","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-10-6","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.10.6 (2022-10-25)","text":"Interactive functions modify lesson structure (move_episode(), set_episode(), etc) now display message user specify write = TRUE. message present command , executed, make desired change (requested: @tobyhodges, #345, fixed: @zkamvar, #352)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-10-5","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.10.5 (2022-10-24)","text":"source config parameter trailing / trimmed passed site URL two consectutive slashes.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-10-4","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.10.4 (2022-10-07)","text":"renv/sandbox longer required .gitignore. new bug introduced 0.10.2 caused lessons built 0.10.2 fail rebuilt CI. due assumption .gitignore item renv/sandbox strictly necessary clear method automatically update file like (reported: @zkamvar, #347; fixed: @zkamvar, #348).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-10-3","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.10.3 (2022-10-05)","text":"accidental commit sandpaper-version.txt version 0.8.0 inside workflow templates folder causing workflow update script create pull requests workflows every week much less frequent (irony commit trigger another pull request) (fixed: @zkamvar, #346).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-10-2","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.10.2 (2022-10-04)","text":"default .gitignore now renv/sandbox avoid sandbox directory tracked git. (see https://github.com/rstudio/renv/issues/1088) (reported: @zkamvar; #344, fixed: @zkamvar, #343)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-10-2","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.10.2 (2022-10-04)","text":"deploy-aws.yaml workflow removed plans use relegated beta stage workbench.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-10-1","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.10.1 (2022-09-28)","text":"index.md (Rmd) file title YAML element, take precedence default title “Summary Setup”. (requested: @SaraMorsy, #339; fixed: @zkamvar #342)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-10-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.10.1 (2022-09-28)","text":"Titles navigation bar now Markdown parsed correctly.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-10-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.10.0 (2022-09-19)","text":"default behavior create_episode() create_lesson() use episodes without numbered prefixes now automatically add episodes schedule (requested: @tobyhodges, #330; fixed @zkamvar, #333) New function move_episode() allows lesson contributor move episode schedule (requested: @tobyhodges, #330, fixed: @zkamvar, #333) New functions draft_lesson_md() draft_lesson_rmd() perform task create_lesson(add = FALSE). Helper function strip_prefix() automatically strip prefixes episodes schedule.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-10-0","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.10.0 (2022-09-19)","text":"get_config() now default path argument. bug anchors callout headings generic names (e.g. “discussion” “keypoints”) missing fixed.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-9-6","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.9.6 (2022-09-15)","text":"minor bug fixed. originated recent update {cli} newlines span collapsed. fix (reported: @zkamvar, #336; fixed @zkamvar #337)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-9-6","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.9.6 (2022-09-15)","text":"minimum version CLI updated version 3.4.0","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-9-6","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.9.6 (2022-09-15)","text":"Pull request response workflows updated make sure conditionals always default TRUE (see https://github.com/carpentries/actions/pull/56)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-095-2022-08-30","dir":"Changelog","previous_headings":"","what":"sandpaper 0.9.5 (2022-08-30)","title":"sandpaper 0.9.5 (2022-08-30)","text":"css js can now embedded individual pages custom styling (see https://bookdown.org/yihui/rmarkdown-cookbook/html-css.html implementation details). pandoc extension link_attributes added process custom link classes (see https://pandoc.org/MANUAL.html#extension-link_attributes details).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-094-2022-08-26","dir":"Changelog","previous_headings":"","what":"sandpaper 0.9.4 (2022-08-26)","title":"sandpaper 0.9.4 (2022-08-26)","text":"CLI styling important message {renv} fixed readable (reported: @zkamvar, #331; fixed: @zkamvar, #332). bioschemas metadata version updated 1.0 (reported: @zkamvar, #329; fixed @zkamvar, #332).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-9-3","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.9.3 (2022-08-12)","text":"test failing R-universe skipped documentation updated detail expected optional values config.yaml set_dropdown() template code conduct updated reflect style guide","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-9-2","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.9.2 (2022-08-09)","text":"version s3-sync action corrected. affects lessons deploy AWS","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-9-1","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.9.1 (2022-08-09)","text":"Anchor links now included sections callouts easy navigation sections. Thanks @fiveop @anenadic requesting feature. requested #285 https://github.com/carpentries/workbench/issues/28; fixed #325","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-9-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.9.0 (2022-07-12)","text":"set_config() gains option create, create new variables exist.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-9-0","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.9.0 (2022-07-12)","text":"new workflow called deploy-aws.yaml created deploy site AWS right secrets AWS available. workflow affect normal use, relegating patch release.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-8-0","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.8.0 (2022-07-06)","text":"new workflow called pr-preflight.yaml created perform quick pre-flight check pull request ensure malicious activity lesson , may look like modifying workflow lesson files pull request. lessons transition workbench styles official community-developed lessons, extra check added validate branch incoming PR contain invalid commits. Pull Request workflows simplified.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-7-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.7.1 (2022-07-05)","text":"bug fail_on_error defaulted true fixed. default false key present config.yaml (#314, @zkamvar).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-feature-0-7-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURE","title":"sandpaper 0.7.0 (2022-07-01)","text":"Placing fail_on_error: true config.yaml set global chunk option error = FALSE R Markdown documents, meaning error produced chunk, build fail unless chunk explicitly uses error = TRUE option. (requested: #306 @davidps, implemented: #310 @zkamvar)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-6-2","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.6.2 (2022-06-24)","text":"sidebar navigation mobile tablet views now includes information included navigation bar desktop mode. (reported: https://github.com/carpentries/workbench/issues/16#issuecomment-1165307355 @Athanasiamo #306, fixed: #309 @zkamvar) downit shims updated resiliant upstream changes","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-6-1","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.6.1 (2022-06-22)","text":"config.yaml template updated default incubator lessons helpful information included formatting (@tobyhodges, #302)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-6-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.6.0 (2022-06-10)","text":"create_lesson() gains rmd parameter, logical indicator lesson use R Markdown (TRUE default). FALSE, markdown lesson created package cache initialised. create_episode() gains ext parameter, allows users create plain markdown episodes need R Markdown functionality (see https://github.com/carpentries/sandpaper/issues/296).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-6-0","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.6.0 (2022-06-10)","text":"create_episode() now slugify titles contain lowercase ASCII letters, numbers UTF-8 characters words separated single hyphens (see https://github.com/carpentries/sandpaper/issues/294).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-6-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.6.0 (2022-06-10)","text":"internal check_episode() function removed - engineered marginal value.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-5-8","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.5.8 (2022-06-06)","text":"Running main workflow GitHub’s actions tab now uses checkbox indicate markdown file cache cleared. README file workflows longer contains link image exist.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-5-7","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.5.7 (2022-05-27)","text":"Workflows update lesson elements now report obvious summary next steps take invalid token (see https://github.com/carpentries/actions/pull/45)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-5-6","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.5.6 (2022-05-25)","text":"Pull requests now report elements lesson pass checks.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-5-5","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.5.5 (2022-05-23)","text":"New YAML items can now added -available varnish {{#yaml}} context. internal function set_dropdown() preserve yaml items explicitly coded config menu.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-5-4","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.5.4 (2022-05-18)","text":"build_episode_md() argument workenv now defaults globalenv() avoid S3 dispatch issues can occur new.env() (see https://github.com/carpentries/sandpaper/issues/288)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-5-3","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.5.3 (2022-05-18)","text":"Episodes ampersands titles longer break aggregate page building.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"temporary-bug-fix-0-5-2","dir":"Changelog","previous_headings":"","what":"TEMPORARY BUG FIX","title":"sandpaper 0.5.2 (2022-05-16)","text":"{downlit} shim updated longer fail parsing BASH globs. (see https://github.com/r-lib/downlit/pull/138)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-5-1","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.5.1 (2022-05-03)","text":"sidebar now enumerates episodes easier instructors learners indicate episode number instead name (suggested @fiveop #276). (@zkamvar, #277)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-suggests-0-5-1","dir":"Changelog","previous_headings":"","what":"NEW SUGGESTS","title":"sandpaper 0.5.1 (2022-05-03)","text":"{mockr} now suggested package (aka soft-dependency) facilitate testing functions need entire lesson set test functionality","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-5-1","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.5.1 (2022-05-03)","text":"setup-r setup-pandoc actions pinned version 2 setup-r action now uses default R installation GitHub’s runner, decreases build times ~ 1 minute. R actions use RStudio Package Manager, avoid overly lengthy build times. explicit permissions set deploy workflow (@zkamvar, #279)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-5-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.5.0 (2022-04-22)","text":"images.html built internal function build_images(), collecting images displaying alt text non-screen reader users (marking paragraphs aria-hidden screen reader users read twice). instructor-notes.html now built internal function build_instructor_notes() now collects instructor notes episodes section called aggregate-instructor-notes.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-5-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.5.0 (2022-04-22)","text":"internal build_agg_page() new argument, append, takes XPath expression node children appended. Defaults \"self::node()\". example alternate usage build_instructor_notes(), uses section[@id='aggregate-instructor-notes'].","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-4-1","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.4.1 (2022-04-21)","text":"One page Keypoints page redesigned. now use underlying internal function build_agg_page() (build aggregate page). allows slow templating processes performed cached instead repeated page. provides framework future aggregate pages (figures, instructor notes, glossary, etc). message now printed Keypoints --one pages written disk quiet = FALSE.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-4-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.4.0 (2022-04-13)","text":"--one page now available lesson websites /aio.html instructor/aio.html.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-4-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.4.0 (2022-04-13)","text":"Provisioning global lesson element cache (metadata, AST, global variables varnish) now executed via this_lesson(), run validate_lesson(). simplifies setup bit, provides method cache invalidation (checking git outputs) elements","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-3-6","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.3.6 (2022-04-09)","text":"custom sandpaper varnish engines properly linked footer lesson pages via version varnish 0.1.8. testthat tests updated. diagram vingettes updated reflect parallel roles sandpaper pegboard lesson.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-3-5","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.3.5 (2022-03-04)","text":"keypoints.html now rendered key-points.html fix navigation error varnish.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-3-4","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.3.4 (2022-03-02)","text":"pr-receive.yaml updated report errors workflow updates. See https://github.com/carpentries/sandpaper/issues/263 details","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-3-3","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.3.3 (2022-02-28)","text":"Links index page setup episodes now correctly render Links setup page now redirect index.html#setup (@zkamvar, #262) setup page now included instructor view schedule setup index page now separate section id “setup” schedule instructor index page now separate section id “schedule”","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-3-3","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.3.3 (2022-02-28)","text":"minimum version {varnish} required now 0.1.5","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-3-3","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.3.3 (2022-02-28)","text":"small bug update cache workflow caused silent error detremental effect fixed (@zkamvar, #250)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-3-2","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.3.2 (2022-02-25)","text":"minimum version {pegboard} least 0.2.3 accomodate div validation (@sstevens2, #259) minimuim version {varnish} least 1.5.0.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-3-1","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.3.1 (2022-02-23)","text":"Documents footnotes without trailing newlines now parse external links correctly adding newline document links.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-3-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.3.0 (2022-02-22)","text":"Common links markdown lessons can included via file top lesson called links.md. file exists, concatenated markdown file rendered HTML. Thanks @sstevens2 bringing feature (@zkamvar, #257) create_lesson() now includes links.md main directory. new help page called ?sandpaper.options provides documentation global options used sandpaper lesson (subject change).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-2-0","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.2.0 (2022-02-18)","text":"validate_lesson() perform checks links fenced divs lesson. now included calls build_lesson(), ci_deploy() serve() (@zkamvar, #255)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-2-0","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.2.0 (2022-02-18)","text":"minimum pegboard version now 0.2.0","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-2-0","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.2.0 (2022-02-18)","text":"internal function this_lesson() now properly invalidate reset change commit (e.g. lesson build switched).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-1-6","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.1.6 (2022-02-14)","text":"set_dropdown() longer fails {cli} version 3.2.0","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"internal-0-1-5","dir":"Changelog","previous_headings":"","what":"INTERNAL","title":"sandpaper 0.1.5 (2022-02-11)","text":"metadata now processed consistently across page types, first foremost reduces code complexity, second, allows rapid development future page types. instances, result marginal improvement build times, likely noticable.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-1-4","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.1.4 (2022-02-10)","text":"sandpaper::build_lesson() longer creates infinite loop called sandpaper::serve() (@zkamvar, #247)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-1-3","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.1.3 (2022-02-03)","text":"Clarify license information specify copyright held Carpentries","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-1-2","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.1.2 (2022-02-02)","text":"invalid sitemaps fixed correct namespace include slash site name. test requring pandoc 2.11 suppressed systems without version pandoc.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependencies-0-1-1","dir":"Changelog","previous_headings":"","what":"DEPENDENCIES","title":"sandpaper 0.1.1 (2022-02-01)","text":"{pegboard} package now required 0.1.0 greater due fix generating keypoints page (https://github.com/carpentries/pegboard/pull/76)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"metadata-0-1-1","dir":"Changelog","previous_headings":"","what":"METADATA","title":"sandpaper 0.1.1 (2022-02-01)","text":"metadata included lesson footer now correctly states @type TrainingMaterial (@zkamvar, #236) basic sitemap now constructed lesson (@zkamvar, #243)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-1-1","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.1.1 (2022-02-01)","text":"Empty pages longer throw errors rendering included output (@zkamvar, #237)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fixes-0-1-0","dir":"Changelog","previous_headings":"","what":"BUG FIXES","title":"sandpaper 0.1.0 (2022-02-01)","text":"internal function render_html() now passes --preserve-tabs parameter prevent pandoc removing educationally relevant information lessons. rebuilding lesson ci_deploy(..., rebuild = TRUE), detritus lesson site cleaned (@zkamvar, #91).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"breaking-changes-0-1-0","dir":"Changelog","previous_headings":"","what":"BREAKING CHANGES","title":"sandpaper 0.1.0 (2022-02-01)","text":"Add support updated frontend {varnish}. means need varnish 0.1.0 installed order use update. change includes modifications lua filters along general handling HTML elements means older versions varnish cease work. code blocks longer contain package links. links may handy sighted users explore documentation, may represent objstructions users rely screen-readers.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"instructor-view-0-1-0","dir":"Changelog","previous_headings":"","what":"INSTRUCTOR VIEW","title":"sandpaper 0.1.0 (2022-02-01)","text":"now two views lesson: instructor view learner view. biggest difference instructor view gains instructor-note sections (exist). Static pages view. means can toggle pages without needing javascript. Removed timings learner view (avoid discouraging learners) Setup page replaces schedule index page additional buttons included instructor view yet work, work point! downside moment building lesson takes bit longer due fact now render two pages change.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"navigation-0-1-0","dir":"Changelog","previous_headings":"","what":"NAVIGATION","title":"sandpaper 0.1.0 (2022-02-01)","text":"persistant sidebar links main content lesson present pages lesson. navigation bar prioritise items used frequently respective audiences: Learners: Key Points, Glossary, Learner Profiles, “Additional Information” (dropdown) Instructors: Key Points, Instructor Notes, Extract Images, “” (dropdown)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-1-0","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.1.0 (2022-02-01)","text":"build database now gains “date” column indicate date file last rendered markdown. allows “last updated ” better reflect state contents rendered files. default configuration file now includes keywords: item can place comma-separated list keywords include site’s metadata configuration file now also includes example provisioned navigation looks like default episode template now refers correct documentation links provides examples represent code blocks evaluated. setup page now contains structured example setup page shows provide dropdown menus different operating systems (@zkamvar, #28). user github PAT can detect name repository git setup, source goes example.com link.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9075","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9075","text":"Episodes missing timing metadata longer fail also contain questions objectives blocks. (@zkamvar, #222).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9074","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9074","text":"Internal function renv_cache_available() continues work {renv} 0.15.0. new version {renv} changed default value configuration setting system cache logical NULL, casued logical operation fail. (@zkamvar, #223)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependency-update-0-0-0-9073","dir":"Changelog","previous_headings":"","what":"DEPENDENCY UPDATE","title":"sandpaper 0.0.0.9073","text":"{renv} pinned version 0.14.0 version 0.13.2 throw error checking consent.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-function-0-0-0-9072","dir":"Changelog","previous_headings":"","what":"NEW FUNCTION","title":"sandpaper 0.0.0.9072","text":"serve() now allows work lesson automatically rebuild whenever save files disk.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-dependencies-0-0-0-9072","dir":"Changelog","previous_headings":"","what":"NEW DEPENDENCIES","title":"sandpaper 0.0.0.9072","text":"{servr} now used serve() function.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-feature-0-0-0-9071","dir":"Changelog","previous_headings":"","what":"NEW FEATURE","title":"sandpaper 0.0.0.9071","text":"Lesson blocks now treated blocks. placeholder us better test separation lesson veiw default learner view.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9070","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9070","text":"Lessons readonly zlib compressed files (read: git objects) can now websites built. (@zkamvar, #214)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9069","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9069","text":"build_handout() now officially exported function. pkgdown documentation updated","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9068","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9068","text":"Workflows updated use ubuntu-latest instead macOS-11. macOS runners often ~ 1 minute faster ubuntu runners, tradeoff potential failures packages available binary versions need compilation external C libraries (along runs failing due brew timeouts). update coincides update github actions, now check install ubuntu dependencies updating/installing packages. (@zkamvar, #184)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9067","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9067","text":"situation git fail remove everything fixed (#206, @zkamvar) Addressed CLI failures due glue version 1.5.0 (https://github.com/r-lib/cli/issues/370#issuecomment-965496848)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"api-change-0-0-0-9066","dir":"Changelog","previous_headings":"","what":"API CHANGE","title":"sandpaper 0.0.0.9066","text":"set_config() now takes named vector/list instead pair vectors.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9065","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9065","text":"set_config() set singular items configuration file (@zkamvar, #193)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9064","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9064","text":"Package discovery now respects lesson environment, unfixed 0.0.0.9063","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9063","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9063","text":"package cache can now built external {renv} environments (@zkamvar, #197).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9062","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9062","text":"New lessons specify custom titles reflected config file (@zkamvar, #195).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9061","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9061","text":"lessons colons title now correctly processed (@zkamvar, #192) code injection yaml now protected setting eval.expr = FALSE yaml parsing calls.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9060","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9060","text":"title lesson now appear index page.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9060","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9060","text":"translation script longer lives lesson repo moved (modified) https://data-lessons/lesson-transition/","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9059","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9059","text":"scheduler update-cache.yaml fixed run strictly first Tuesday month instead first seven days month Tuesdays.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9058","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9058","text":"update-cache.yaml simplified pull carpentries/actions repository now updates packages previously included lockfile (#185).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9057","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9057","text":"update-cache.yaml fixed regression introduced 4b8b14d088d03a8a9c6c90e974bb53c35691fb49 workflow run check repository beforehand.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9056","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9056","text":"update_github_workflows() now sets clean = \"*.yaml\" default align behavior GitHub workflow prevent stale workflows present repository. (#181, @zkamvar)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9055","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9055","text":"sandpaper-main.yaml pr-receive.yaml simplified using composite actions hosted carpentries/actions/setup-sandpaper carpentries/actions/setup-deps. caching mechanism R packages package cache can now reset modifying per-repository secret called CACHE_VERSION.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9055","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9055","text":"bug introduced 0.0.0.9054 dependencies discovered fixed.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9054","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9054","text":"manage_deps() runs slightly faster now longer runs renv::hydrate() new packages added lesson.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9053","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9053","text":"setting option(sandpaper.handout = TRUE) create code handout R lessons live /files/code-handout.R site.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9053","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9053","text":"internal caching mechanism added pegboard::Lesson objects use extracting components syllabus handout. See ?lesson_storage details.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9052","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9052","text":"pr-receive.yaml fixed spelling. pr-receive.yaml changed short-cut invalid PR messages longer build lesson PR invalid. Instead, emit warning message without building artifacts. pr-comment.yaml longer fail artifacts exist (cause extraneous emails users).","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"documentation-0-0-0-9052","dir":"Changelog","previous_headings":"","what":"DOCUMENTATION","title":"sandpaper 0.0.0.9052","text":"Documentation test fixtures improved include branch functions.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9051","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9051","text":"template pull request message reverts back two-dot diff notation branches, temporary #169 can addressed. Linebreaks within paragraphs removed avoid github formatting linebreaks.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009050","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9050","title":"sandpaper 0.0.0.9050","text":"update {sandpaper} brings dependency management lessons generated content make collaboration lessons much easier less invasive establishing package cache lockfile via {renv} R package.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"introduction-0-0-0-9050","dir":"Changelog","previous_headings":"DEPENDENCY MANAGEMENT","what":"Introduction","title":"sandpaper 0.0.0.9050","text":"use {renv} package controlling dependency management lesson, contained {renv} profile called “lesson-requirements”. implemented profile instead default {renv} environment give maintainers flexibility whether want use package cache.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"consent-for-using-the-package-cache-0-0-0-9050","dir":"Changelog","previous_headings":"DEPENDENCY MANAGEMENT","what":"Consent for Using the Package Cache","title":"sandpaper 0.0.0.9050","text":"getOption('sandpaper.use_renv') set {sandpaper} loads detect contributor previously consented use {renv} package. TRUE, lesson use package cache, otherwise, lesson use default library. use_package_cache() give consent {sandpaper} create use package cache via {renv}. Internally, enforces options(sandpaper.use_renv = TRUE). no_package_cache() opposite use_package_cache() revokes consent use package cache lesson temporarily. can useful situtations cache mis-behaving want test lesson using newer set packages. Internally, enforces options(sandpaper.use_renv = FALSE). package_cache_trigger(TRUE) allows trigger full rebuild lockfile changes. set TRUE default ci_build_markdown()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"managing-the-package-cache-0-0-0-9050","dir":"Changelog","previous_headings":"DEPENDENCY MANAGEMENT","what":"Managing the Package Cache","title":"sandpaper 0.0.0.9050","text":"manage_deps() new function manage dependencies lesson. called create_lesson() build_markdown() ensure correct dependencies lesson installed. explicitly calls use_package_cache() runs. update_cache() bring updates lesson cache. pin_version() pin packages specific version, allowing authors upgrade downgrade packages .","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9050","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9050","text":"create_lesson() now additionally create {renv} profile called “packages” lesson repository getOption('sandpaper.use_renv') TRUE. make lesson portable. index README files can now Rmd files (though recommended use .renvignore files avoid {sandpaper} becoming part package cache). internal function ci_deploy() set sandpaper.use_renv option TRUE build_markdown() thus build_lesson() now cache config.yaml renv.lock. longer step build process markdown files need rebuilt. cause project built previous versions sandpaper fully rebuilt. sandpaper_site() (thus, build_lesson()) now can take single file rendering render specific file regardless present cache without rendering files. addresses #77. (n.b. involved changes build_markdown(), build_site(), build_status()). varnish_vars() list contains commonly used variables lesson can contained config.yaml build_episode() build_home() now supply default variables varnish.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continous-integration-0-0-0-9050","dir":"Changelog","previous_headings":"","what":"CONTINOUS INTEGRATION","title":"sandpaper 0.0.0.9050","text":"unexported function ci_deploy() now automatically check set git user email. sandpaper-main.yaml pr-receive.yaml updated include {renv} cache, skip steps markdown lessons. update-cache.yaml new workflow update package cache lockfile create pull request trigger new builds lesson uses {renv}. update-workflows.yaml now produces informative instructions creating repository secret.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9050","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9050","text":"{callr} functions made non-anonymous moved separate file tested independently.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9050","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9050","text":"changes config.yaml now reflected lesson site without rebuilding (fixes #75) knitr option root.dir set output directory avoid generated content entering source.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009049","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9049","title":"sandpaper 0.0.0.9049","text":"placeholder testing 0.0.0.9050.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9048","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9048","text":"pandoc lua filter longer errors raw div HTML elements class (@zkamvar, #166)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9047","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9047","text":"update-workflows.yaml workflow now checks SANDPAPER_WORKFLOW secret valid. , provides instructions creating new secret.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9046","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9046","text":"Weekly run pull requests now default “weekly run” “triggered pull request”","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9045","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9045","text":"Weekly run added workflows action Actions updated reflect zkamvar -> carpenteries repository transfer (@zkamvar, #156)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"contiuous-integration-0-0-0-9044","dir":"Changelog","previous_headings":"","what":"CONTIUOUS INTEGRATION","title":"sandpaper 0.0.0.9044","text":"update-workflow.yaml parameters fixed use wildcards","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9044","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9044","text":"update_github_workflows() gains clean argument now print status reports end.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9043","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9043","text":"update-workflow.yaml workflow updated use github action hosted zkamvar/actions (soon transferred Carpentries account names actions displayed GitHub updated descriptive. script inst/scripts/update-workflows.sh removed favor github action.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9042","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9042","text":"experimental update-workflow.yaml workflow created create pull request update workflows. still experimental requires scoped repo scope, , nevertheless, concept currently valid.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9041","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9041","text":"fetch_github_workflows() renamed update_github_workflows() github workflows longer downloaded external source; now live inst/workflows. reduce internet connection requirements setting lesson testing sandpaper. create_lesson() now reports progress goes along tests updated use fixtures","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9040","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9040","text":"ci_deploy() gains reset argument, can used clear cache clean build lesson. ci_deploy() now uses ci_build_markdown() ci_build_site(), internally","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9039","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9039","text":"ci_session_info() report session information, help clean workflow files.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9038","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9038","text":"Fix broken deploy process continuous integration caused attempting fetch branches shallow clone (@zkamvar, #142)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9037","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9037","text":"Output ci_bundle_pr_artifacts() longer escapes HTML-like output diff summary. remove {xml2} explicit dependencies","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9036","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9036","text":"Documentation git_worktree_setup() added future versions maintainer future contributors. ci_bundle_pr_artifacts() new internal function create artifacts GitHub upload upon receipt pull request. replace clunky shell code lived inside YAML configuration file. (@zkamvar, #139) add {brio} soft dependencies (testing, maybe speed ???)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"continuous-integration-0-0-0-9035","dir":"Changelog","previous_headings":"","what":"CONTINUOUS INTEGRATION","title":"sandpaper 0.0.0.9035","text":"Tests git operations added robust (@zkamvar, #137) new test fixtures local remote repository added aid git tests.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9034","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9034","text":"Authors can now cross-link files within lesson appear lesson instead trying guess link appear website. example, wanted reference learners/setup.md episodes/introduction.md, write [setup](../learners/setup.md) automatically converted correct URL website (#43). still backwards compatible previous iteration writing flattened link (appear website).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9033","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9033","text":"get_drafts() report markdown files currently published lesson. Draft alert notifications controlled \"sandpaper.show_draft\" option. turn messages, use options(sandpaper.show_draft = FALSE) set_dropdown() family functions now throw error author attempts add file exist error occurr files listed config.yaml exist lesson informative message highlighting files missing.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9032","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9032","text":"internal get_resource_list() function modified incorporate features get_dropdown(). means get_dropdown() functions report files dropdown menus actually exist directory (#134). persistant test fixture now included speed testing time (#132 via #134)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9031","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9031","text":"{cli} package now official import package warning message issued internal warn_schedule() function changed exclusively use cli messages can suppressed suppressMessages(). internal sandpaper_cli_theme() used style CLI messages.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9030","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9030","text":"test caused problems new version {pegboard} fixed","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9029","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9029","text":"internal database updated use relative instead absolute paths. fixes #129","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-imports-0-0-0-9028","dir":"Changelog","previous_headings":"","what":"NEW IMPORTS","title":"sandpaper 0.0.0.9028","text":"{pingr} package now imported check online access, marginally decrease data usage (@fmichonneau, #127).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9027","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9027","text":"create_schedule() (internal function) longer uses pegboard’s extensions fixing reference links.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"misc-0-0-0-9026","dir":"Changelog","previous_headings":"","what":"MISC","title":"sandpaper 0.0.0.9026","text":"callout blocks headers greater h3 now rendered properly longer forced h3 tests now clean longer change working directory default {varnish} version bumped 0.0.0.9005 tests require pandoc skipped pandoc available tests presences multiple files use setequal instead equal allow alternate sorting orders.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"dependency-update-0-0-0-9025","dir":"Changelog","previous_headings":"","what":"DEPENDENCY UPDATE","title":"sandpaper 0.0.0.9025","text":"required {pegboard} bumped version 0.0.0.9014 {renv} {sessioninfo} added Suggested packages.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9024","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9024","text":"create_lesson() now enforce “main” default branch (init.defaultBranch set) default branch new lesson. also try make URL match project name user name (latter limited users GitHub PAT set {gh} recognises).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9023","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9023","text":"build_episode_md() now sets knitr.pandoc.knit option allow chunk option fig.cap rendered caption. fixes #114.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9023","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9023","text":"set_dropdown() now generalized set item dropdown menu (though likely wrapped better-named function generalized editing). system.file(\"transform.R\", pacakge = \"sandpaper\") points file used transforming styles-repo era lessons sandpaper lessons. read/write cycles reduced markdown generation longer interfering manipulation files stage (haven’t now).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9022","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9022","text":"build_markdown(rebuild = TRUE) now actually rebuilds lesson Changing episode suffix longer result build error. due build_markdown() trying clean building output instead . ’s situation throwing baby bathwater. case, fixes #102.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9021","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9021","text":"template initialized folders placeholders inside instructor/ profile/ menus. fixes #103.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9020","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9020","text":"set_*() functions longer mess yaml lists config.yaml. fixes #53.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009019","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9019","title":"sandpaper 0.0.0.9019","text":"required version {pegboard} bumped 0.0.0.9012, gives better error messages allows us read {sandpaper} lessons Lesson object.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009018","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9018","title":"sandpaper 0.0.0.9018","text":"episode template rearranged slightly given level 2 headers.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"engine-update-0-0-0-9017","dir":"Changelog","previous_headings":"","what":"ENGINE UPDATE","title":"sandpaper 0.0.0.9017","text":"version pandoc explicitly checked ensure version used least 2.11.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9016","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9016","text":"create_episode() make_prefix = FALSE longer create episodes prefixed - (see #93).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9015","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9015","text":"fetch_github_workflows() download update GitHub workflows Carpentries actions repository. update_varnish() download update {varnish} styling package local repository.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9014","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9014","text":"Episode order retained HTML navigation (#85) index.md recorded site/build/ directory, thus md-pages branch deployment.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"engine-update-0-0-0-9014","dir":"Changelog","previous_headings":"","what":"ENGINE UPDATE","title":"sandpaper 0.0.0.9014","text":"caching mechanism now similar {blogdown} database source files checksum hashes kept updated files built. provides two advantages, first longer peek top files check need updated second can keep files right order (see #85) Importantly, workflow affected, changes gets displayed github diff md-outputs branch.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9013","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9013","text":"RStudio, knit button works 🎉 (fix #77; @zkamvar, #82) sandpaper_site() site generator function allows {rmarkdown} use {sandpaper} machinery build site rmarkdown::render_site() build_site() gains slug argument tailors previewed content. create_lesson() now create blank index.md site: sandpaper_site YAML item. HTML accidentally rendered source directories silently removed site built. (fix #78, @zkamvar, #84)","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"new-features-0-0-0-9012","dir":"Changelog","previous_headings":"","what":"NEW FEATURES","title":"sandpaper 0.0.0.9012","text":"Inline reference-based footnotes now supported.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9011","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9011","text":"Bare links text emoji (e.g. 😉) now rendered (fix #67). Objectives Questions headings now longer rendered (fix #64).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9010","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9010","text":"index.md exists top level, used instead README.md lesson index page (fix #56).","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9009","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9009","text":"lua filter responsible creating Objectives summary block beginning episodes now uses native pandoc divs instead HTML block shims. ensures content corrupted pandoc’s section divs extension. addresses issue #64 aside elements forced level 3 headers (fixes issue pandocs –section-divs couldn’t understand HTML block contained start aside tag decided end section right . Objectives Questions blocks longer include headers initial summary block. bug introduced version 0.0.0.9008 fixed. bug improperly used regex resulting accidental removal cached rendered images. fixes issue #49 Rendered images now prefix {SOURCE}-rendered- site/built/fig/ subdir.","code":""},{"path":[]},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"bug-fix-0-0-0-9008","dir":"Changelog","previous_headings":"","what":"BUG FIX","title":"sandpaper 0.0.0.9008","text":"files removed source now also removed site/built directory. fixes issue #47","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009007","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9007","title":"sandpaper 0.0.0.9007","text":"HTML now processed pandoc lua filters following: overview block constructed teaching exercises metadata question objectives blocks instructor callout divs converted <aside> tags divs without H2 level headers automatically inserted divs incorrect level headers converted H2 divs list carpentries divs converted README updated reflect API changes","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009006","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9006","title":"sandpaper 0.0.0.9006","text":"Continuous integration functions added: ci_deploy() build markdown source site commit separate branches, including information source. ci_build_markdown() build markdown source files commit separate branch, including information source commit. ci_build_site() build site directly markdown branch, bypassing re-rendering markdown files. Miscellaneous additions {dovetail} longer suggests new internal function build_site() compartmentalizes conversion markdown html files folders named .git episodes directory copied website.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009005","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9005","title":"sandpaper 0.0.0.9005","text":"CODE_OF_CONDUCT.md learners/Setup.md instructors/ profiles/ LICENSE.md _schedule() functions renamed _episodes(). clean_*() functions now renamed reset_*() Generic set/get/reset_dropdown() functions created facilitate modification/access folders dropdown menus inside lesson questionable practices directories mucking . build_markdown() now generate artifacts site/built/assets/ directory instead episodes/ directory prevent generated artifacts included git (See https://github.com/carpentries/sandpaper/issues/24)","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009004","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9004","title":"sandpaper 0.0.0.9004","text":"Internal html_from_md() renamed render_html() Internal build_episode() renamed build_episode_html() exported, documentation still internal Internal build_single_episode() renamed build_episode_md() exported, documentation still internal","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009003","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9003","title":"sandpaper 0.0.0.9003","text":"regression build_markdown() due called separate process fixed. Internal functions setting {knitr} options migrated live inside build_markdown()","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009002","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9002","title":"sandpaper 0.0.0.9002","text":"Migrate template use fenced divs instead {dovetail}. build_lesson() now render HTML episode titles. {callr} now imported protect processes building markdown HTML files.","code":""},{"path":"https://carpentries.github.io/sandpaper/dev/news/index.html","id":"sandpaper-0009001","dir":"Changelog","previous_headings":"","what":"sandpaper 0.0.0.9001","title":"sandpaper 0.0.0.9001","text":"Add override argument build_lesson(). gets passed pkgdown::as_pkgdown() control site gets built. Update dependency {pegboard} 0.0.0.9006, includes $questions field make parsing ever shifting landscape bit easier. First tracking version NEWS","code":""}]