diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.nojekyll @@ -0,0 +1 @@ + diff --git a/404.html b/404.html new file mode 100644 index 0000000..e0b5fd7 --- /dev/null +++ b/404.html @@ -0,0 +1,106 @@ + + +
+ + + + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+Examples of behavior that contributes to a positive environment for our community include:
+Examples of unacceptable behavior include:
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at phgrosjean@sciviews.org. All complaints will be reviewed and investigated promptly and fairly.
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+Community Impact: A violation through a single incident or series of actions.
+Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
+Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+Consequence: A permanent ban from any sort of public interaction within the community.
+This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder][https://github.com/mozilla/inclusion].
+For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+YEAR: 2024 +COPYRIGHT HOLDER: Philippe Grosjean ++ +
Copyright (c) 2024 Philippe Grosjean
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+vignettes/learnitgrid.Rmd
+ learnitgrid.Rmd
TODO…
+Marking work on the basis of marking grids is time-consuming and requires particular attention to ensure fair marking from one student to another.
+learnitgrid, via a new web application {shiny}, makes it possible to mark all the work in a series criterion by criterion. The relevant part of each piece of work, identified by a title or a piece label, is extracted from the R/R Markdown/ Quarto documents. These extracts are grouped and sorted automatically using a text similarity calculation algorithm in the {stringdist} package. This makes it easier to score similar responses in the same way. This method also reduces the time needed for correction. Clickable links allow quick access to the complete job and to any context (dataset, additional documents, etc.), which further improves the speed of correction and the user’s comfort when filling in the criteria grids.
+This package is associated with and enhances the {learnitdown} package.
+You can install the development version of {learnitgrid} from GitHub with:
+
+# install.packages("remotes")
+remotes::install_github("learnitr/learnitgrid")
This is a basic example which shows you how to solve a common problem:
+
+library(learnitgrid)
+## basic example code
NEWS.md
+ R/check_grids.R
+ check_grids.Rd
This function checks all evaluation grids in a correction set and computes +the required statistics for the summary page of the learnitgrid shiny app.
+check_grids(dir, save.log = TRUE, save.rds = TRUE)
The path to the evaluation grids
Should a log file be saved (yes by default)?
Should an RDS file with the data be saved (yes by default)?
A data frame with the results of the evaluation grids check for the +learnitgrid Shiny app.
+R/utils.R
+ chunk_labels.Rd
Make proper Rmd/Qmd chunk labels from strings for parsermd::parse_rmd()
+chunk_labels(x)
A character string of chunk labels to convert
A character string of the same length as x
with "educated" labels.
chunk_labels(c("Summer is hot", "", NA, " ", "Winter is cold "))
+#> [1] "Summer_is_hot" "" NA " "
+#> [5] "Winter_is_cold"
+
R/utils.R
+ correct_rmd.Rd
Make sure that Rmd/Qmd chunk labels are written without spaces
+correct_rmd(rmd)
Character string with the content of a Rmd/Qmd file.
The same Rmd/Qmd content, but with "educated" chunk labels.
+Create a list that contains context for a given correction set (must be +recalculated when a different correction set/project is selected).
+create_context(
+ correction,
+ base_corr_dir,
+ base_templ_dir,
+ base_repos_dir,
+ repositories,
+ assignments,
+ github_url,
+ branch
+)
The correction set
The base directory for correction sets
The base directory for correction templates
The vase directory for GitHub repositories to correct
The repositories
The assignments
The GitHub URL (base part)
The GitHub branch concerned by this correction
A list with the context information for the learnitgrid Shiny app.
+Make sure a directory exists, or create it
+dir_path_create(...)
+
+dir_path_check(...)
+
+file_path_check(...)
The successive folders that make the path.
A path object is returned invisibly.
+dir_path_check()
: Check that a directory exists.
file_path_check()
: Check that a file exists.
test_path <- dir_path_create(tempdir(), "dir_path_create_test", "subfolder")
+test_path
+#> /tmp/RtmpAcbx3h/dir_path_create_test/subfolder
+dir.exists(test_path) # Should be TRUE
+#> [1] TRUE
+dir_path_check(test_path) # Return the path only if it exists
+# Remove
+unlink(test_path)
+unlink(dirname(test_path))
+
R/get_git_stats.R
+ get_git_stats.Rd
Use data from a git_stats.csv file to get a history of commits +done in a repository for the learnitgrid Shiny app.
+get_git_stats(
+ git_stats_file,
+ exclude_authors = "github-classroom[bot]",
+ type = "all",
+ tz = "UTC"
+)
The path the the git_stats.csv file
The list of authors to exclude from the stats
The type of files to consider ("all", "R", "Rmd", or "Qmd")
The time zone to use for times
A data frame with git stats data to be used by the learnitgrid Shiny +app.
+
+ All functions+ + |
+ |
---|---|
+ + | +Summarize and check evaluation grids for the learnitgrid Shiny app |
+
+ + | +Make proper Rmd/Qmd chunk labels from strings for parsermd::parse_rmd() |
+
+ + | +Make sure that Rmd/Qmd chunk labels are written without spaces |
+
+ + | +Create a context object for a correction set |
+
+ + | +Make sure a directory exists, or create it |
+
+ + | +Summarize the git stats for one or more git repositories |
+
+ + | +Create symbolic links under www subdirectory or strip www subdirectory from the path |
+
+ + | +Computes the content of a DT::datatable for a correction set |
+
R/learnitgrid-package.R
+ learnitgrid-package.Rd
Create and manage semi-automatically rubrics to assess GitHub projects (R scripts, R Markdown or Quarto files). Create directed projects where students have to complete documents and submit them to GitHub (classroom) so that they are evaluated using the rubric (or assessment grid).
+The learnitgrid package allows to create and manage semi-automatically +rubrics to assess GitHub projects (R scripts, R Markdown or Quarto files). +Create directed projects where students have to complete documents and submit +them to GitHub (classroom) so that they are evaluated using the rubric +(or assessment grid).
+create_context()
creates a context object (a list) with ...
populate_table()
computes the content for a DT::datatable()
with the
+evaluation grid information.
Useful links:
R/utils.R
+ link_to_www.Rd
Symbolic links in the www subdirectory of the Shiny app are +required for the application to properly display html documents or images in +html tags.
+link_to_www(path, link)
+
+www_relative(path)
The (absolute) path containing the documents.
The name to use for the symbolic link under the www subdirectory of the Shiny app.
TRUE
if the symbolic link exists for link_to_www()
or FALSE
otherwise. The modified path is returned bywww_relative()
www_relative()
: Strip www/ in front of the relative paths for a Shiny app.
R/populate_table.R
+ populate_table.Rd
The most important function for the learnitgrid Shiny app to fill in the +table according to selected items with a list of grids (or "all") or +according to a selected grid with a list of items (or "all")
+populate_table(
+ items,
+ grids = "all",
+ context,
+ reorder = (length(items) == 1),
+ highlight = FALSE,
+ max_lines = 20L
+)
The items of the evaluation grid to display in the table, +usually either one item, or "all" for everything
The evaluation grids to display, usually either "all" if only +one item, or one grid if "all" items
A context object as computed by create_context()
.
Should the rows in the table be reordered by similarities?
+This is usually TRUE
for a single items, or FALSE
otherwise (and it is
+computed as such by default).
Syntax highlighting for code (slow, thus FALSE
by default)
The maximum number of content lines that are displayed +(truncate very long contents).
A data frame with the content to be displayed in a DT::datatable object.
+