-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathtool_template.rmd
62 lines (38 loc) · 1.39 KB
/
tool_template.rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
---
title: "Abbreviation or short title for Tool (e.g., ScaleArch for Basic Analysis for Scale Archiving"
subtitle: "Full title"
author:
- name: "author 1"
- name: "author 2"
- name: "author 3"
image: images/tool_icon.png #takes from a folder "images" in your github repository the tool icon file
date: "`r format(Sys.Date(), '%B %d, %Y')`"
format:
html: default
pdf: default
bibliography: references.bib
biblio-style: apa
---
# At a glance
<!-- Summary with main points of the tool in 2-3 bullet points -->
### Table of Content
[Introduction](#introduction)
[Setup](#setup)
[Tool application](#tool-application)
[Conclusion and recommendations](#conclusion-and-recommendations)
# Introduction
# Set-up
## Data/Data and Measures/...
<!--this heading is not mandatory and can be adjusted to your specific tool structure-->
## Getting started
<!-- for package installation and loading data sets; heading is not mandatory -->
# Tool application
<!--subheadings for tool application can be specified "freely" and depending on structure of your tool -->
::: {.callout-note title="Custom Note Title"}
This can be additional information you want to provide and visually
separate from your main text.
:::
<!-- Additional information can be included as callout blocks with titles, such as
"Be careful", "Good to know", or "Package-specific feature"-->
# Conclusion and recommendations
# References