oh-my-posh/website/docs/segments/r.md

56 lines
1.5 KiB
Markdown
Raw Normal View History

2022-03-19 01:06:06 -07:00
---
id: r
title: R
sidebar_label: R
---
## What
Display the currently active [R][r-homepage] version.
## Sample Configuration
```json
{
"type": "r",
"style": "powerline",
"powerline_symbol": "\uE0B0",
"foreground": "blue",
"background": "lightWhite",
2022-03-27 01:12:47 -07:00
"template": " R {{ .Full }} "
2022-03-19 01:06:06 -07:00
}
```
## Properties
- home_enabled: `boolean` - display the segment in the HOME folder or not - defaults to `false`
- fetch_version: `boolean` - display the R version - defaults to `true`
- display_error: `boolean` - show the error context when failing to retrieve the version information - defaults to `true`
- missing_command_text: `string` - text to display when the command is missing - defaults to empty
- display_mode: `string` - determines when the segment is displayed
- `always`: the segment is always displayed
- `files`: the segment is only displayed when `*.R`, `*.Rmd`, `*.Rsx`, `*.Rda`, `*.Rd`, `*.Rproj`, or `.Rproj.user`
files are present (default)
## Template ([info][templates])
:::note default template
``` template
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
```
:::
### Properties
- `.Full`: `string` - the full version
- `.Major`: `string` - major number
- `.Minor`: `string` - minor number
- `.Patch`: `string` - patch number
- `.URL`: `string` - URL of the version info / release notes
- `.Error`: `string` - error encountered when fetching the version string
2022-03-19 01:06:06 -07:00
2022-04-20 09:43:59 -07:00
[templates]: /docs/configuration/templates
2022-03-19 01:06:06 -07:00
[r-homepage]: https://www.r-project.org/