The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.
Organizr provides opinionated code-shortcuts to quickly create R scripts, as well as minimal Quarto and Rmarkdown documents with a consistent naming scheme.
Organizr offers a count-based prefix…
R/
001_first-script.R
002_another-script.R
003_and-so-on.R… and a date-based prefix.
R/
2022-09-24_first-script.R
2022-09-26_another-script.R
2022-09-26_and-so-on.RYou can install the development version of organizr like so:
# install.packages("devtools") # if you do not have devtools installed
devtools::install_github("jobrachem/organizr")Organizr offers the four following functions:
r() creates an R script with a timestamp in
project_path/R.py() creates a Python script with a timestamp in
project_path/py.qmd() creates a minimal Quarto document in
project_path/qmd.rmd() creates a minimal Quarto document in
project_path/rmd.Organizr is an opinionated packaged. It may very well be that it does not fit your personal workflow, and that’s ok.
The best user experience arises, if you load organizr in
the .Rprofile of your current project. To do so, you can
use the following line to open your project’s .Rprofile:
# install.packages("usethis")
usethis::edit_r_profile(scope = "project")Then place the following code inside the .Rprofile:
if (interactive()) {
suppressMessages(require(organizr))
}This will always load up the library organizr in
interactive R sessions. Now, you will always be able to create
consistently named new R scripts via quick and simple function calls
like
r("my-script")If this is the first R file in your project, this function call will
create the file 001_my-script.R in the directory
project_path/R.
You can set some global options via
options("option_name" = "option_value")If you want to use options, it often makes sense to also place them directly in the .Rprofile file.
Example:
With this function call, you set the default prefix used by
organizr to “date”:
options("organizr.prefix_by" = "date")| Option | Meaning |
|---|---|
organizr.prefix_delim |
Which character to insert as a separator between the prefix and the
actual file name. The default is "_" |
organizr.prefix_by |
Can be used to override the function default of
"count". Can be "count" or
"date". |
organizr.prefix_date_format |
Date format for date prefixes. Can be any format string accepted by
strftime. Default is "%Y-%m-%d". |
| Option | Meaning |
|---|---|
organizr.r.init_with_date |
Can be set to FALSE to turn off the inclusion of the
timestamp comment at the top of the script. |
organizr.r.date_format |
Date format for R and Python script timestamp comment. Can be any
format string accepted by strftime. Default is
"%Y-%m-%d %H:%M". |
organizr.r.directory |
The directory in which the scripts should be place (relative to the project directory) |
| Option | Meaning |
|---|---|
organizr.py.init_with_date |
Can be set to FALSE to turn off the inclusion of the
timestamp comment at the top of the script. |
organizr.py.date_format |
Date format for R and Python script timestamp comment. Can be any
format string accepted by strftime. Default is
"%Y-%m-%d %H:%M". |
organizr.py.directory |
The directory in which the scripts should be place (relative to the project directory) |
| Option | Meaning |
|---|---|
organizr.rmd.directory |
The directory in which .Rmd files should be place
(relative to the project directory) |
organizr.qmd.directory |
The directory in which .qmd files should be place
(relative to the project directory) |
These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.