Package: org 2024.6.5
Richard Aubrey White
org: Organising Projects
A framework for organizing R projects with a standardized structure. Most analyses consist of three main components: code, results, and data, each with different requirements such as version control, sharing, and encryption. This package provides tools to set up and manage project directories, handle file paths consistently across operating systems, organize results using date-based structures, source code from specified directories, create and manage Quarto documents, and perform file operations safely. It ensures consistency across projects while accommodating different requirements for various types of content.
Authors:
org_2024.6.5.tar.gz
org_2024.6.5.zip(r-4.5)org_2024.6.5.zip(r-4.4)org_2024.6.5.zip(r-4.3)
org_2024.6.5.tgz(r-4.5-any)org_2024.6.5.tgz(r-4.4-any)org_2024.6.5.tgz(r-4.3-any)
org_2024.6.5.tar.gz(r-4.5-noble)org_2024.6.5.tar.gz(r-4.4-noble)
org_2024.6.5.tgz(r-4.4-emscripten)org_2024.6.5.tgz(r-4.3-emscripten)
org.pdf |org.html✨
org/json (API)
NEWS
| # Install 'org' in R: |
| install.packages('org', repos = c('https://csids.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/csids/org/issues
Pkgdown site:https://www.csids.no
On CRAN:org-2024.6.5(2024-06-04)
Last updated 13 days agofrom:f6ecbe09a6. Checks:9 OK. Indexed: yes.
| Target | Result | Latest binary |
|---|---|---|
| Doc / Vignettes | OK | Mar 19 2025 |
| R-4.5-win | OK | Mar 19 2025 |
| R-4.5-mac | OK | Mar 19 2025 |
| R-4.5-linux | OK | Mar 19 2025 |
| R-4.4-win | OK | Mar 19 2025 |
| R-4.4-mac | OK | Mar 19 2025 |
| R-4.4-linux | OK | Mar 19 2025 |
| R-4.3-win | OK | Mar 19 2025 |
| R-4.3-mac | OK | Mar 19 2025 |
Exports:create_project_quarto_external_resultscreate_project_quarto_internal_resultsinitialize_projectls_filesmove_directorypackage_installedpathprojectset_resultswrite_text
Dependencies:
Citation
To cite package ‘org’ in publications use:
White RA (2022). org: Organising Projects. R package version 2024.6.5, , https://github.com/csids/org.
Corresponding BibTeX entry:
@Manual{,
title = {org: Organising Projects},
author = {Richard Aubrey White},
year = {2022},
note = {R package version 2024.6.5, },
url = {https://github.com/csids/org},
}
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Create example project that uses quarto with results generated outside the .qmd file | create_project_quarto_external_results |
| Create example project that uses quarto with results generated from within the .qmd file | create_project_quarto_internal_results |
| Initialize project | initialize_project |
| List files and directories | ls_files |
| Move directory | move_directory |
| Check if a package is installed and optionally install it | package_installed |
| Construct path to a file or directory | path |
| Folders to be used/referenced | project |
| Set results folder after initialization | set_results |
| Write text to a file | write_text |
