Data

Tools

Indexes

Applications

Experiments

Open Source Science

projrsimple

Initialise and run a simple project workflow

https://github.com/miguelrodo/projrsimple

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Initialise and run a simple project workflow

Basic Info
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 3
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation Codemeta

README.Rmd 

---
output: github_document
---



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

# projrsimple


[![R-CMD-check](https://github.com/MiguelRodo/projrsimple/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/MiguelRodo/projrsimple/actions/workflows/R-CMD-check.yaml)


The goal of `projrsimple` is to make it easy to run a clean project workflow.

It helps you initialise a reproducible project structure with predefined
directories, run analysis scripts, and ensure clean output directories
with minimal effort.

## Installation

You can install the development version of `projrsimple` like so:

``` r
if (!requireNamespace("remotes", quietly = TRUE)) {
  install.packages("remotes")
}
remotes::install_github("MiguelRodo/projrsimple")
```

## TL;DR

1. Install `projrsimple` (see above).
2. Open an R session in your project directory (folder where you want to work).
3. Run `projr_init()` to initialise your project.
4. Write code in scripts (`.R`, `.Rmd`, `.qmd` and/or Quarto projects) in the project directory.
5. Run `projr_run` to execute all scripts. Save outputs to `_output` directory.
6. View rendered documents in the `docs` directory.

To connect to GitHub automatically, run `projr_init(init_github = TRUE)` (step 3) *after* the following steps:

1. Create a GitHub account ([link](https://www.github.com)).
2. Set up a personal access token (PAT) in R ([instructions](https://happygitwithr.com/https-pat#tldr)).

## Details

For details, view the introductory article on the [package website](https://miguelrodo.github.io/projrsimple/articles/intro.html) or as a vignette (`vignette("intro", package = "projrsimple")`).

## Citation

To cite `projrsimple` in publications, use:

> **Miguel Rodo** (2024). *projrsimple: Initialise and run a simple project workflow.* Version 1.0.0. Available at: [https://github.com/MiguelRodo/projrsimple](https://github.com/MiguelRodo/projrsimple/#readme).

Alternatively, in `BibTeX` format:

```bibtex
@Misc{rodo,
  title = {projrsimple: Initialise and run a simple project workflow},
  author = {Miguel Rodo},
  url = {https://github.com/MiguelRodo/projrsimple/#readme},
  abstract = {Initialise and run a simple R project workflow},
  version = {1.0.0},
}
```

Owner

  • Name: Miguel Rodo
  • Login: MiguelRodo
  • Kind: user

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "projrsimple",
  "description": "Initialise and run a simple project workflow",
  "name": "projrsimple: Initialise and run a simple project workflow",
  "relatedLink": "https://github.com/MiguelRodo/projrsimple/#readme",
  "codeRepository": "https://github.com/MiguelRodo/projrsimple",
  "issueTracker": "https://github.com/MiguelRodo/projrsimple/issues",
  "license": "https://spdx.org/licenses/CC-BY-4.0",
  "version": "1.0.0",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.4.2 (2024-10-31)",
  "author": [
    {
      "@type": "Person",
      "givenName": "Miguel",
      "familyName": "Rodo",
      "email": "miguel.rodo@uct.ac.za"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Miguel",
      "familyName": "Rodo",
      "email": "miguel.rodo@uct.ac.za"
    }
  ],
  "softwareRequirements": {
    "SystemRequirements": null
  },
  "fileSize": "1.38KB",
  "citation": [
    {
      "@type": "CreativeWork",
      "author": [
        {
          "@type": "Person",
          "givenName": "Miguel",
          "familyName": "Rodo",
          "email": "miguel.rodo@uct.ac.za"
        }
      ],
      "name": "projrsimple: Initialise and run a simple project workflow",
      "url": "https://github.com/MiguelRodo/projrsimple/#readme"
    }
  ]
}

GitHub Events

Total
  • Issues event: 3
  • Public event: 1
  • Push event: 41
Last Year
  • Issues event: 3
  • Public event: 1
  • Push event: 41

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 1
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • MiguelRodo (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v4 composite
  • quarto-dev/quarto-actions/setup v2 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • devtools * suggests
  • gert * suggests
  • gh * suggests
  • quarto * suggests
  • renv * suggests
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests
  • usethis * suggests
  • withr * suggests
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.5.0 composite
  • actions/checkout v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite