###-----------------------------------------------------------------------------
### This Readme file is a generic template that automatically creates a minimal
### readme file. You only have to change the following two lines, and then in
### the rest of the file, the bits in between the comment blocks marking the
### custom bits for every package. The general info will be generated
### automatically.
###-----------------------------------------------------------------------------

packagename <- 'mdmcda';
packageSubtitle <- "Multi-Decision Multi-Criteria Decision Analysis";

###-----------------------------------------------------------------------------

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

gitLab_ci_badge <-
  paste0("https://gitlab.com/r-packages/", packagename, "/badges/prod/pipeline.svg");
gitLab_ci_url <-
  paste0("https://gitlab.com/r-packages/", packagename, "/commits/prod");

codecov_badge <-
  paste0("https://codecov.io/gl/r-packages/", packagename, "/branch/prod/graph/badge.svg");
codecov_url <-
  paste0("https://codecov.io/gl/r-packages/", packagename, "?branch=prod");

dependency_badge <-
  paste0("https://tinyverse.netlify.com/badge/", packagename);
dependency_url <-
  paste0("https://CRAN.R-project.org/package=", packagename);

gitlab_url <-
  paste0("https://gitlab.com/r-packages/", packagename);

pkgdown_url <-
  paste0("https://r-packages.gitlab.io/", packagename);

hexlogo <- ifelse(file.exists("img/hex-logo.png"),
                  "<img src='img/hex-logo.png' align=\"right\" height=\"200\" /> ",
                  "");

r paste0(hexlogo, packagename, " \U1F4E6")

r packageSubtitle

Pipeline status

Coverage status

The pkgdown website for this project is located at r pkgdown_url and its Git repository is located at r gitlab_url.

See the introductory vignette for an introduction. The Dutch MDMA Policy Think Tank that was active in 2019-2020 used this package to formulate policy recommendations. The rendered report of that project, including all code, is located at https://denktank.gitlab.io/mdma-policy-mdmcda; the corresponding Git repository at https://gitlab.com/denktank/mdma-policy-mdmcda; and the accompanying Open Science Framework repository which contains frozen registrations at https://osf.io/h58r6.

Other R packages for MCDA are the MCDA package, the MCDM package, and DecisionAnalysis package.

Installation

You can install the released version of r packagename from CRAN with:

cat(paste0("``` r
install.packages('", packagename, "');
```"));

You can install the development version of r packagename from GitLab with:

cat(paste0("``` r
remotes::install_gitlab('r-packages/", packagename, "');
```"));

If you want the even more cutting edge version, you can install from the dev branch (as opposed to the default branch, prod) with:

cat(paste0("``` r
remotes::install_gitlab('r-packages/", packagename, "@dev');
```"));

(This is assuming you have the remotes packages installed; otherwise, install that first using the install.packages function.)



Matherion/mdmcda documentation built on Dec. 31, 2020, 3:13 p.m.