diff --git a/README.html b/README.html new file mode 100644 index 0000000..5763832 --- /dev/null +++ b/README.html @@ -0,0 +1,438 @@ + + + + + + + + + + + + + +README.knit + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
+

rspell

+

This package aims to provide grammar check in R, specially for +RStudio users editing notebooks. As some tools like Grammarly and +LanguageTools are not (yet) directly integrated to the IDE, this is a +temporary solution.

+

rspell uses the LanguageTool API and can +verify grammar for several languages and was inspired by the ggspellpackage.

+
+

Usage

+

First, install the package.

+
remotes::install_github("rfsaldanha/rspell")
+

Then, select some text on your notebook and run the +check_selection command.

+
rspell::check_selection()
+

At the console, possible grammar errors will be shown, and you will +be asked to modify or not the text. The LanguageTool API will +automatically try to discover your text language.

+
+
+

Add-in and keyboard shortcut

+

For a faster use, you can use the package’s RStudio add-in. After +installing the package, it will be available at the add-in list. You can +also map a keyboard +shortcut for it, like Ctrl+g.

+
+
+

More options

+

It is possible to just show the errors without asking to modificate +the selection.

+
rspell::check_selection(ask_modify = FALSE)
+

And to specify the language (available +options at the API).

+
rspell::check_selection(language = "FR")
+
+
+ + + + +
+ + + + + + + + + + + + + + + diff --git a/README.md b/README.rmd similarity index 100% rename from README.md rename to README.rmd