Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hongyuanjia/idftags

Create EnergyPlus IDF Tags for Vim
https://github.com/hongyuanjia/idftags

Last synced: about 1 month ago
JSON representation

Create EnergyPlus IDF Tags for Vim

Awesome Lists containing this project

README

        

---
output: github_document
---

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

# idftags

The goal of idftags is to create [ctags](https://github.com/universal-ctags/ctags)-compatible
tag file for [EnergyPlus](https://energyplus.net) IDFs.

## Installation

You can install the released version of idftags from [GitHub](https://github.com/hongyuanjia/idftags) with:

```r
# install.packages("remotes")
remotes::install_github("hongyuanjia/idftags")
```

## Example

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

```{r example}
library(idftags)
file <- system.file("extdata/1ZoneUncontrolled.idf", package = "eplusr")
build_idf_tags(file)
```

## Use together with Vim

- Install [vista.vim](https://raw.githubusercontent.com/liuchengxu/vista.vim)
using [vim-plug](https://github.com/junegunn/vim-plug)

```vim
Plug 'liuchengxu/vista.vim'
```

- Add below to your vimrc

```vim
let g:vista_ctags_cmd = {
\ 'idf': 'Rscript -e "idftags::build_idf_tag(cmd = TRUE)"'
\ }
```

```{r, out.width = "50%"}
knitr::include_graphics("tools/vista.png")
```