Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vrognas authored Sep 3, 2024
1 parent a259669 commit 6f54974
Showing 1 changed file with 37 additions and 23 deletions.
60 changes: 37 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,44 +7,58 @@ A [Visual Studio Code](https://code.visualstudio.com/) [extension](https://marke

## Installation

To install the extension, open the Extensions view, search for `nonmem` to filter results and select NMTRAN extension.
To install the extension, open the Extensions view, search for `nonmem` to filter results and select the NMTRAN extension.

## Overview of the extension features
## Declarative Language Features

### Syntax highlighting

![demo_syntax-highlight](images/demo_syntax-highlight.png)

### Snippets

![demo_advan-snippets](images/demo_advan-snippets.gif)
* Comment toggling using the VS Code command `Toggle Line Comment`
* Folding (by control records)
* Bracket matching
* Bracket autoclosing
* Bracket autosurrounding

Snippets for RUV (normal or log-scale):
* RUV_add
* RUV_prop
* RUV_addprop
### Syntax Highlighting

Snippets for MIXTURE-models (just type $MIX):
* 2-way mixture model
* 3-way mixture model
By tokenization according to [TextMate 1.5.1 naming conventions](https://macromates.com/manual/en/language_grammars#naming_conventions)

Snippets for creating an Xpose-friendly $TABLE scaffold (just type $TABLE).
![demo_syntax-highlight](images/demo_syntax-highlight.png)

Snippet for including IIV on a parameter that is bound between 0 and 1 (type logit_iiv).
### Snippet Completion

### Declarative Language Features
![demo_advan-snippets](images/demo_advan-snippets.gif)

* Comment toggling using the VS Code command `Toggle Line Comment`
* Autoclosing of brackets
#### Snippets
* Subroutine selection
* ADVAN and TRANS
* Modify `$DATA` on-the-fly (Credit: Simon Buatois)
* RUV (normal or log-scale)
* RUV_add
* RUV_prop
* RUV_addprop
* Creating an Xpose-friendly $TABLE scaffold (just type $TABLE).
* MIXTURE-models (just type $MIX)
* 2-way mixture model
* 3-way mixture model
* Including IIV on a parameter that is bound between 0 and 1 (type logit_iiv).
* Baseline modeling (B1, B2, B3, B4) [Dansirikul et al., 2008](https://doi.org/10.1007/s10928-008-9088-2)
* BQL modeling (M3) [Beal, 2001](https://doi.org/10.1023/a:1012299115260)

## Programmatic Language Features

* Diagnostics
* Code completion proposals
* Hover info

## Requirements

VSCode v1.80.0

## Contributing

We encourage your contribution to the project. You can report issues and post suggestions of features via [GitHub issues](https://github.com/vrognas/vscode-nmtran/issues). Thank you!
Your contribution to the project is encouraged.
You can report issues and post suggestions of features via [GitHub issues](https://github.com/vrognas/vscode-nmtran/issues).
Thank you!

## License

[MIT](LICENSE)
[MIT](LICENSE)

0 comments on commit 6f54974

Please sign in to comment.