Data

Tools

Indexes

Applications

Experiments

Open Source Science

pru3di

An opinionated hack to implement the Borealis use-case study on 3Di

https://github.com/rainer-rq-koelle/pru3di

Science Score: 44.0%

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

  • ✓
    CITATION.cff file
    Found 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 (13.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

An opinionated hack to implement the Borealis use-case study on 3Di

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

README.Rmd 

---
output: github_document
---



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

# pru3di


[![R-CMD-check](https://github.com/rainer-rq-koelle/pru3di/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rainer-rq-koelle/pru3di/actions/workflows/R-CMD-check.yaml)


This is a learning-while-doing project. The goal is to explore to workflow and 
practices on how to develop, refine, document, and share a R package.   
The use case is the 3Di algorithm.

3Di is a composite score combining the inefficiencies observed during the 
horizontal and vertical flight phase.

## Installation

You can install the development version of pru3di from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("rainer-rq-koelle/pru3di")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r example}
library(pru3di)
## basic example code
# the following will greet you
xhello("Stranger")
```

What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:

```{r cars}
summary(cars)
```

You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.

You can also embed plots, for example:

```{r pressure, echo = FALSE}
plot(pressure)
```

In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.

Owner

  • Name: Rainer
  • Login: rainer-rq-koelle
  • Kind: user
  • Location: Brussels
  • Company: EUROCONTROL

Head of Operational ANS Performance at EUROCONTROL, Performance Review Unit. Learning to and applying data science techniques to operational ANS Performance.

Citation (CITATION.cff) 

# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.5.0
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "pru3di" in publications use:'
type: software
license: MIT
title: 'pru3di: An opinionated hack to implement the Borealis use-case study on 3Di'
version: 0.0.0.9000
abstract: An opinionated implementation of the 3Di algorithm. The use case serves
  also to allow me to explore the development (and it workflow) of R packages. This
  work-in-progress will ultimately be transferred to a more useful and stable version.
authors:
- family-names: Koelle
  given-names: Rainer
  email: rainer.koelle@eurocontrol.int
  orcid: https://orcid.org/0000-0003-2810-1404
repository-code: https://github.com/rainer-rq-koelle/pru3di
url: https://github.com/rainer-rq-koelle/pru3di
contact:
- family-names: Koelle
  given-names: Rainer
  email: rainer.koelle@eurocontrol.int
  orcid: https://orcid.org/0000-0003-2810-1404

GitHub Events

Total
Last Year

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 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
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v3 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
  • R >= 2.10 depends
  • assertthat * imports
  • dplyr * imports
  • ggplot2 * imports
  • rlang * imports
  • knitr * suggests
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests