check_lesson: Check the lesson structure for errors
In zkamvar/sandpaper: Create and Curate Carpentries Lessons
Description
Usage
Arguments
Value
Examples
Description
Check the lesson structure for errors
Usage
1
2
3
check_episode(path)
check_lesson(path = ".")
Arguments
path
the path to your lesson
Value
TRUE (invisibly) if the lesson is cromulent, otherwise, it will
error with a list of things to fix.
Examples
1
2
3
4
5
6
7
8
9
10
11
12
# Everything should work out of the box
tmp <- tempfile()
create_lesson(tmp, open = FALSE)
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))
unlink(tmp)
zkamvar/sandpaper documentation built on Nov. 25, 2021, 1:16 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value Examples
Description
Check the lesson structure for errors
Usage
1 2 3 | check_episode(path)
check_lesson(path = ".")
|
Arguments
path |
the path to your lesson |
Value
TRUE (invisibly) if the lesson is cromulent, otherwise, it will
error with a list of things to fix.
Examples
1 2 3 4 5 6 7 8 9 10 11 12 | # Everything should work out of the box
tmp <- tempfile()
create_lesson(tmp, open = FALSE)
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))
unlink(tmp)
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.