writing-reusable-code

Writing Reusable and Modular Code

https://github.com/uf-repro/writing-reusable-code

Keywords

Repository

Writing Reusable and Modular Code

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

```{r, include = FALSE}

lesson_title <- "Writing Reusable and Modular Code"
lesson_description <- "This workshop introduces attendees to the principles of writing 'clean' code, that is easier to read, maintain, and expand. Attendees will learn about organizing complex programming scripts into modular functions, writing effective documentation, and habits to improve code robustness and reusability.

*Attendees will be expected to have basic familiarity with programming, such as experience writing simple scripts or recent attendance at a Carpentries workshop* - https://www.uf-carpentries.org/"
lesson_version <- "1.1.3"
lesson_keywords <- c("Open Educational Resources", 
                     "Research Support Skills", 
                     "Version Control", 
                     "Workshop", 
                     "Research Software Engineering", 
                     "Reproducibility", 
                     "Modular Code", 
                     "Style Guide", 
                     "Code Smell")

folder_name <- basename(usethis::proj_get())
package_name <- gsub("-", ".", folder_name)
github_url <- sub("^git@github\\.com:", "https://github.com/", 
                  sub("\\.git$", "", usethis::git_remotes()$origin)
)

desc::desc_set(Package = package_name, 
               Title = lesson_title, 
               Description = lesson_description, 
               Version = lesson_version, 
               URL = github_url, 
               Version = lesson_version, 
               "X-schema.org-keywords" = paste(lesson_keywords, collapse = ", "))

cite_data <- list(
    title = lesson_title, 
    version = lesson_version, 
    creators = list(list(affiliation = "University of Florida", 
                 name = "Hao Ye", 
                 orcid = "0000-0002-8630-1458")), 
    description = lesson_description, 
    keywords = as.list(lesson_keywords), 
    license = cffr:::parse_desc_license(desc::desc()), 
    upload_type = "lesson"
)

jsonlite::write_json(cite_data, ".zenodo.json", 
                     auto_unbox = TRUE, pretty = TRUE)
```

# `r lesson_title`


[![GitHub Actions pkgdown workflow](https://github.com/uf-repro/lesson-template/workflows/pkgdown/badge.svg)](https://github.com/uf-repro/lesson-template/actions?query=workflow%3Apkgdown)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4489867.svg)](https://doi.org/10.5281/zenodo.4489867)



## Description

`r lesson_description`

## Learning Outcomes

```{r, include = FALSE}
learning_outcomes <- c("organize programming tasks into modular functions", 
                       "communicate code intent using comments",
                       "recognize and fix basic code smells")
outcomes_text <- paste0("* ", learning_outcomes, collapse = "\n")
desc::desc_set("learningOutcomes", outcomes_text)
```

By the end of the workshop, participants will be able to:

`r outcomes_text`

Owner

GitHub Events