rmarkdown-action

KO | EN

gitlite — search

#ai #llm #golang #go #android #deep-learning #docker #macos #cli #kubernetes #vue #awesome-list #mcp #open-source

rmarkdown-action

(★ 21)

Github action to render documents using rmarkdown. Includes pandoc and tinytex installations

rmarkdown-action 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Test multiple format rendering](https://github.com/lucharo/rmarkdown-action/workflows/Test%20multiple%20format%20rendering/badge.svg)
![Render and upload docs](https://github.com/lucharo/rmarkdown-action/workflows/Render%20and%20upload%20docs/badge.svg)
# rmarkdown-action

Github action to render documents using rmarkdown. Uses `rocker/r-rmd` docker image which includes rmardkown, pandoc and latex.

## Inputs

* `input_file`: path or name of input file, all with respect to root directory of the repo (e.g: `my_doc.Rmd`, `path/to/my_doc.Rmd`)
* `output_format`: (defaults to `pdf_document`), options are: `word_document`, `html_document` and `pdf_document`.

## Outputs

* `output_file`: This is automatically generated as the name that precedes `.Rmd` + the output format extension (e.g: for `my_doc.Rmd` with `output_format` as `pdf_document` -> `my_doc.pdf`

__Disclaimer:__ By default, the `rmarkdown-action` will simply render the document to desired format. If you also wish to upload the document back to the repo please see [the later section](#uploading-rendered-document-to-github)

## Example

```yaml
name: Render documents with rmarkdown-action
on: [push]
jobs:
  render_document:
    runs-on: ubuntu-latest
    steps:
      - name: Set up Git repository
        uses: actions/checkout@v2
      - name: Render document
        uses: lc5415/rmarkdown-action@v1
        with:
          input_file: path/to/my_doc.Rmd
	  output_format: pdf_document
```

## Other powerful usages

### Uploading rendered document to GitHub

This makes use of the [github-push-action](https://github.com/ad-m/github-push-action) to automatically upload the rendered document to the branch that trigerred the rmarkdown-action. This is useful when the quality of the rendering needs to be reviewed as well (which is almost always the case).

By default, the rendered document will be uploaded to the same location that the input file. If you want to be able to specify the output location please submit an issue.

```yaml
name: Render documents and upload

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  render_document:
    runs-on: ubuntu-latest
    steps:
      - name: Set up Git repository
        uses: actions/checkout@v2
      - name: Render document
        uses: lc5415/rmarkdown-action@v1
        with:
          input_file: path/to/my_doc.Rmd
	  output_format: pdf_document
      - name: Commit files
        run: |
          git config --local core.autocrlf false
          git config --local user.email "${{ github.actor }}@users.noreply.github.com"
          git config --local user.name "${{ github.actor }}"
          git add . && git add --renormalize .
          git pull origin ${{ github.head_ref }} --autostash --rebase -X ours
          git commit --allow-empty -am "AUTO-GH ACTION: ${{ github.workflow }}"
          NO_PAGER=1 git --no-pager diff HEAD^
      - name: Push changes
        uses: ad-m/github-push-action@master
        with:
          branch: ${{ github.head_ref }}
          github_token: ${{ secrets.GITHUB_TOKEN }}
```

rmarkdown-action

rmarkdown-action 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

rmarkdown-action

rmarkdown-action 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README