README.Rmd

--- 
title: "README"
output: 
  md_document:
  variant: markdown_github
  
params:
  NVIpkg: "NVIbatch"
  pkg_path: !r  usethis::proj_path()
  first_copyright_year: "2021"
---

```{r, include = FALSE}
NVIpkg <- params$NVIpkg
NVIpkg_inline <- paste0("`", NVIpkg, "`")
pkg_path <- params$pkg_path

# If hexagon sticker logo exist, include in README.md
logo_path <- ""
if (file.exists(paste0("./man/figures/", NVIpkg, "_logo.png"))) {
  logo_path <- paste0(' <img src="man/figures/', NVIpkg, '_logo.png" align="right" height="138" />')
}

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```

`r paste0(NVIpkg, ": ", desc::desc_get_field(key = "Title"), logo_path)`  
================

<!-- README.md is generated from README.Rmd. Please edit that file -->

  - [Overview](#overview)
  - [Installation](#installation)
  - [Usage](#usage)
  - [Copyright and license](#copyright-and-license)
  - [Contributing](#contributing)

## Overview
```{r, include = FALSE}
description <- desc::desc_get_field(key = "Description")
```
`r paste(NVIpkg_inline, 
   sub(substr(description,1,1), tolower(substr(description,1,1)), description))`

```{r child=system.file('templates', "README_NVIverse.Rmd", package = "NVIpackager")}
```

## Installation
```{r child=system.file('templates', "README_installation.Rmd", package = "NVIpackager")}
```

## Usage
```{r child=system.file('templates', "README_usage_attach.Rmd", package = "NVIpackager")}
```

`r paste0(NVIpkg_inline, 
   " ", 
   sub(substr(description,1,1), tolower(substr(description,1,1)), description))` The vignette "Run R scripts automatically" gives a detailed description on how you can set up an automatic batch job to run an R script on Windows.

```{r child=system.file('templates', "README_usage_help.Rmd", package = "NVIpackager")}
```

## Copyright and license
```{r child=system.file('templates', "README_copyright_and_license.Rmd", package = "NVIpackager")}
```

## Contributing
```{r child=system.file('templates', "README_contributing.Rmd", package = "NVIpackager")}
```

----------------------------
<!-- Code of conduct -->
```{r child=system.file('templates', "README_code_of_conduct.Rmd", package = "NVIpackager")}
```