Data

Tools

Indexes

Applications

Experiments

Open Source Science

inbomd

An R package with a collection of RMarkdown styles and templates. Elaborate examples are available at https://github.com/inbo/INBOmd_examples

https://github.com/inbo/inbomd

Science Score: 67.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
    Found 6 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.4%) to scientific vocabulary

Keywords

bookdown package r rmarkdown xelatex
Last synced: 9 months ago · JSON representation ·

Repository

An R package with a collection of RMarkdown styles and templates. Elaborate examples are available at https://github.com/inbo/INBOmd_examples

Basic Info
Statistics
  • Stars: 12
  • Watchers: 8
  • Forks: 3
  • Open Issues: 7
  • Releases: 12
Topics
bookdown package r rmarkdown xelatex
Created almost 10 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Zenodo

README.md

INBOmd A hexagon with the word INBOmd and the Markdown logo

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Lifecycle: stable License R build status Codecov test coverage GitHub code size in bytes GitHub repo size DOI

INBOmd contains templates to generate several types of documents with the corporate identity of INBO or the Flemish government. The current package has following Rmarkdown templates:

  • INBO pdf_report: reports rendered to pdf, html (gitbook style) and epub
  • INBO slides: presentations rendered to pdf
  • INBO poster: poster rendered to a A0 pdf
  • Flanders slides: presentations using the Flemish corporate identity, rendered to pdf

The templates are available in RStudio using File > New file > R Markdown > From template.

More details, including instructions for installation and usage are available at the INBOmd website.

In the wild

Below are some documents created with INBOmd

  1. https://inbo.github.io/inbomd_examples
  2. https://doi.org/10.21436/inbor.14030462
  3. https://doi.org/10.21436/inbop.14901626
  4. https://pureportal.inbo.be/portal/files/12819590/rbelgium_20170307.pdf
  5. https://doi.org/10.21436/inbor.12304086

Installation

INBOmd requires a working LaTeX distribution (for conversion of markdown to pdf). We highly recommend to use the LaTeX distribution provided by R package tinytex. Close all open R sessions and start a fresh R session. Execute the commands below. This will install the R package tinytex and the TinyTex LaTeX distribution on your machine. No admin rights are required. Although TinyTeX is a lightweight installation, it still is several 100 MB large.

``` update.packages(ask = FALSE, checkBuilt = TRUE) if (!"tinytex" %in% rownames(installed.packages())) { install.packages("tinytex") }

install the TinyTeX LaTeX distribution

if (!tinytex:::istinytex()) { tinytex::installtinytex() } ```

Once TinyTeX is installed, you need to restart RStudio. Then you can proceed with the installation of INBOmd.

```

installation from inbo.r-universe

install.packages("INBOmd", repos = "https://inbo.r-universe.dev")

alternative: installation from github

if (!"remotes" %in% rownames(installed.packages())) {

install.packages("remotes")

}

remotes::install_github("inbo/INBOmd", dependencies = TRUE)

add the local latex package contained in INBOmd to the TinyTeX install

tinytex::tlmgrconf( c("auxtrees", "add", system.file("localtex", package = "INBOmd")) )

install some other needed latex packages

tinytex::tlmgr_install(c( "inconsolata", "times", "tex", "helvetic", "dvips", "hyphen-dutch", "hyphen-french" )) ```

Owner

  • Name: Research Institute for Nature and Forest (INBO)
  • Login: inbo
  • Kind: organization
  • Location: Belgium

Open source, data and science initiatives of the Research Institute for Nature and Forest (INBO)

Citation (CITATION.cff) 

cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
title: "INBOmd: Markdown Templates for INBO"
authors:
- given-names: Thierry
  family-names: Onkelinx
  affiliation: Research Institute for Nature and Forest (INBO)
  orcid: 0000-0001-8804-4216
keywords:
- markdown
- bookdown
- corporate identity
- template
contact:
- given-names: Thierry
  family-names: Onkelinx
  affiliation: Research Institute for Nature and Forest (INBO)
  orcid: 0000-0001-8804-4216
doi: 10.5281/zenodo.842223
license: GPL-3.0
repository-code: https://github.com/inbo/INBOmd/
type: software
abstract: "Several templates to generate reports, presentations and posters."
identifiers:
- type: doi
  value: 10.5281/zenodo.842223
- type: url
  value: https://inbo.github.io/INBOmd/
version: 0.6.3

GitHub Events

Total
  • Watch event: 1
  • Push event: 3
  • Pull request review event: 1
Last Year
  • Watch event: 1
  • Push event: 3
  • Pull request review event: 1

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 78
  • Total pull requests: 95
  • Average time to close issues: 7 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 8
  • Total pull request authors: 7
  • Average comments per issue: 1.73
  • Average comments per pull request: 0.81
  • Merged pull requests: 82
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 6
  • Average time to close issues: 23 days
  • Average time to close pull requests: 17 days
  • Issue authors: 2
  • Pull request authors: 4
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.17
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • florisvdh (22)
  • ThierryO (12)
  • hansvancalster (5)
  • ElsLommelen (2)
  • wlangera (1)
  • pietervsd (1)
  • jwijffels (1)
  • ToonHub (1)
Pull Request Authors
  • ThierryO (32)
  • florisvdh (16)
  • ElsLommelen (5)
  • janneadolf (2)
  • peterdesmet (1)
  • wlangera (1)
  • hansvancalster (1)
Top Labels
Issue Labels
enhancement (17) bug (9) question (4) wontfix (3)
Pull Request Labels
enhancement (3) bug (2)

Dependencies

DESCRIPTION cran
  • assertthat * imports
  • bookdown >= 0.23.4 imports
  • dplyr * imports
  • gert * imports
  • htmltools * imports
  • knitr * imports
  • pdftools * imports
  • qrcode >= 0.1.2 imports
  • rmarkdown * imports
  • utils * imports
  • DT * suggests
  • INBOtheme >= 0.5.4 suggests
  • ggplot2 * suggests
  • pander * suggests
  • rstudioapi * suggests
  • webshot * suggests
.github/workflows/check_on_branch.yml actions
  • inbo/actions/check_pkg master composite
.github/workflows/check_on_different_r_os.yml actions
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • actions/upload-artifact master composite
  • r-lib/actions/setup-pandoc master composite
  • r-lib/actions/setup-r master composite
.github/workflows/check_on_main.yml actions
  • inbo/actions/check_pkg master composite
.github/workflows/examples.yml actions
  • actions/checkout v2 composite
  • inbo/actions/render_inbomd master composite
.github/workflows/release.yml actions
  • actions/checkout v2 composite
  • actions/create-release v1 composite
.github/workflows/remove_old_artifacts.yml actions
  • c-hive/gha-remove-artifacts v1 composite
Dockerfile docker
  • ubuntu 20.04 build