From 314366bfd96df269ac0c8eaee94568bdd253b458 Mon Sep 17 00:00:00 2001 From: rfsaldanha Date: Thu, 21 Mar 2024 15:34:32 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20rfsaldan?= =?UTF-8?q?ha/rspell@e6e6040c74f86f6f1063f5988ae2f9cdc9f860e7=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 9 ++++++++- LICENSE-text.html | 8 +++++++- LICENSE.html | 10 ++++++++-- authors.html | 14 ++++++++++---- index.html | 27 +++++++++++++++++++++------ news/index.html | 10 ++++++++-- pkgdown.yml | 2 +- reference/check_selection.html | 10 ++++++++-- reference/check_text.html | 10 ++++++++-- reference/index.html | 8 +++++++- search.json | 2 +- 11 files changed, 87 insertions(+), 23 deletions(-) diff --git a/404.html b/404.html index 3c4a21f..35506c6 100644 --- a/404.html +++ b/404.html @@ -50,7 +50,14 @@ - + diff --git a/LICENSE-text.html b/LICENSE-text.html index c33797c..5956659 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -33,7 +33,13 @@ - + diff --git a/LICENSE.html b/LICENSE.html index 2e40be1..81bee30 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -33,7 +33,13 @@ - + @@ -41,7 +47,7 @@

MIT License

- + Source: LICENSE.md
diff --git a/authors.html b/authors.html index 5d2dcc6..167cda8 100644 --- a/authors.html +++ b/authors.html @@ -33,7 +33,13 @@ -
    +
    @@ -54,14 +60,14 @@

    Authors

    Citation

    -

    +

    Source: DESCRIPTION

    Saldanha R (2024). -rspell: Grammar Check and Change on Documents. +rspell: Grammar Check Documents on RStudio. R package version 0.0.5, https://rfsaldanha.github.io/rspell/. 

    @Manual{,
-  title = {rspell: Grammar Check and Change on Documents},
+  title = {rspell: Grammar Check Documents on RStudio},
   author = {Raphael Saldanha},
   year = {2024},
   note = {R package version 0.0.5},
diff --git a/index.html b/index.html
index 99ae36a..f0d70c5 100644
--- a/index.html
+++ b/index.html
@@ -5,14 +5,14 @@
 
 
 
-
-Grammar Check and Change on Documents • rspell
+
+Grammar Check Documents on RStudio • rspell
 
 
 
 
-
-
+
+
  Project Options... --> Spelling --> Main dictionary language Tools --> Global Options... --> Spelling --> Main dictionary language rspell::check_selection(language = \"FR\")"},{"path":"https://rfsaldanha.github.io/rspell/index.html","id":"add-in-and-keyboard-shortcut","dir":"","previous_headings":"","what":"Add-in and keyboard shortcut","title":"Grammar Check and Change on Documents","text":"faster use, can use package’s RStudio add-. installing package, available add-list. can also map keyboard shortcut , like Ctrl+g.","code":""},{"path":"https://rfsaldanha.github.io/rspell/index.html","id":"modify-or-just-list-the-errors","dir":"","previous_headings":"","what":"Modify or just list the errors","title":"Grammar Check and Change on Documents","text":"possible just show errors without asking modificate selection.","code":"rspell::check_selection(ask_modify = FALSE)"},{"path":"https://rfsaldanha.github.io/rspell/reference/check_selection.html","id":null,"dir":"Reference","previous_headings":"","what":"Check current selection — check_selection","title":"Check current selection — check_selection","text":"Check grammar errors selected text recommend corrections possible.","code":""},{"path":"https://rfsaldanha.github.io/rspell/reference/check_selection.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check current selection — check_selection","text":"","code":"check_selection(ask_modify = TRUE, language = NULL)"},{"path":"https://rfsaldanha.github.io/rspell/reference/check_selection.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check current selection — check_selection","text":"ask_modify logical. TRUE, prompt shown asking alter document correction . language character. Code like en-US, fr-FR, etc. auto automatic language detection.","code":""},{"path":"https://rfsaldanha.github.io/rspell/reference/check_selection.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check current selection — check_selection","text":"object return function, expects run interactive session.","code":""},{"path":"https://rfsaldanha.github.io/rspell/reference/check_text.html","id":null,"dir":"Reference","previous_headings":"","what":"Grammar check a text — check_text","title":"Grammar check a text — check_text","text":"Grammar check text","code":""},{"path":"https://rfsaldanha.github.io/rspell/reference/check_text.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Grammar check a text — check_text","text":"","code":"check_text(text, language = \"auto\")"},{"path":"https://rfsaldanha.github.io/rspell/reference/check_text.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Grammar check a text — check_text","text":"text character. character object text check. language character. Code like en-US, fr-FR, etc. auto (default) automatic language detection.","code":""},{"path":"https://rfsaldanha.github.io/rspell/reference/check_text.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Grammar check a text — check_text","text":"tibble grammar checks.","code":""},{"path":"https://rfsaldanha.github.io/rspell/reference/check_text.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Grammar check a text — check_text","text":"","code":"check_text(\"O rato roeu a roupa do rei de roma.\", language = \"pt-BR\") #> # A tibble: 1 × 11 #>   message          shortMessage replacements offset length context      sentence #>                                             #> 1 Encontrado poss… Erro ortogr…            30      4  O rato … #> # ℹ 4 more variables: type , rule , #> #   ignoreForIncompleteSentence , contextForSureMatch  check_text(\"Bernardo climb the stairs to the castle’s ramparts.\", language = \"auto\") #> Waiting 2s for throttling delay ■■■■■■■■■■■■■■■                  #> Waiting 2s for throttling delay ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■   #> # A tibble: 1 × 11 #>   message          shortMessage replacements offset length context      sentence #>                                             #> 1 The singular pr… Agreement e…         9      5  Bernard… #> # ℹ 4 more variables: type , rule , #> #   ignoreForIncompleteSentence , contextForSureMatch "},{"path":"https://rfsaldanha.github.io/rspell/news/index.html","id":"rspell-005","dir":"Changelog","previous_headings":"","what":"rspell 0.0.5","title":"rspell 0.0.5","text":"Function check_text() now exported. Improve messages. Modify internal function names.","code":""},{"path":"https://rfsaldanha.github.io/rspell/news/index.html","id":"rspell-004","dir":"Changelog","previous_headings":"","what":"rspell 0.0.4","title":"rspell 0.0.4","text":"Improve documentation arguments assertion.","code":""},{"path":"https://rfsaldanha.github.io/rspell/news/index.html","id":"rspell-003","dir":"Changelog","previous_headings":"","what":"rspell 0.0.3","title":"rspell 0.0.3","text":"Primarily, adopt spelling language defined RStudio’s Project Options. defined, uses spelling language Global options. Verifies text size accordingly LanguageTool API rules (20KB maximum size). Ignore case looking rproj files.","code":""},{"path":"https://rfsaldanha.github.io/rspell/news/index.html","id":"rspell-002","dir":"Changelog","previous_headings":"","what":"rspell 0.0.2","title":"rspell 0.0.2","text":"Prompt modify text default choice (just press Enter). Move focus console back source. Messages improvements. query LanguageTool API selection empty. use query cache API call. Throttle requests rate accordingly LanguageTool API rules (20 requests per minute).","code":""},{"path":"https://rfsaldanha.github.io/rspell/news/index.html","id":"rspell-001","dir":"Changelog","previous_headings":"","what":"rspell 0.0.1","title":"rspell 0.0.1","text":"package now observes default project language set.","code":""},{"path":"https://rfsaldanha.github.io/rspell/news/index.html","id":"rspell-0009","dir":"Changelog","previous_headings":"","what":"rspell 0.0.0.9","title":"rspell 0.0.0.9","text":"First version, basic functions.","code":""}]
+[{"path":"https://rfsaldanha.github.io/rspell/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 rstudiogrammar authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://rfsaldanha.github.io/rspell/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Raphael Saldanha. Author, maintainer.","code":""},{"path":"https://rfsaldanha.github.io/rspell/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Saldanha R (2024). rspell: Grammar Check Documents RStudio. R package version 0.0.5, https://rfsaldanha.github.io/rspell/.","code":"@Manual{,   title = {rspell: Grammar Check Documents on RStudio},   author = {Raphael Saldanha},   year = {2024},   note = {R package version 0.0.5},   url = {https://rfsaldanha.github.io/rspell/}, }"},{"path":"https://rfsaldanha.github.io/rspell/index.html","id":"rspell","dir":"","previous_headings":"","what":"Grammar Check Documents on RStudio","title":"Grammar Check Documents on RStudio","text":"package aims provide grammar check R, specially RStudio users editing notebooks. tools like Grammarly LanguageTools (yet) directly integrated IDE, temporary solution. rspell uses LanguageTool API can verify grammar several languages inspired ggspellpackage.","code":""},{"path":"https://rfsaldanha.github.io/rspell/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Grammar Check Documents on RStudio","text":"First, install package. , select text RStudio (notebook, script, documentation…) run check_selection command console. Possible grammar errors shown console, asked modify text.","code":"remotes::install_github(\"rfsaldanha/rspell\") rspell::check_selection()"},{"path":"https://rfsaldanha.github.io/rspell/index.html","id":"language-selection","dir":"","previous_headings":"","what":"Language selection","title":"Grammar Check Documents on RStudio","text":"package prioritize spelling dictionary set RStudio’s project configuration. set, project use spelling dictionary set Global Options. can also manually specify language (available options API). set language = \"auto\", LanguageTool API try guess language.","code":"Tools --> Project Options... --> Spelling --> Main dictionary language Tools --> Global Options... --> Spelling --> Main dictionary language rspell::check_selection(language = \"FR\")"},{"path":"https://rfsaldanha.github.io/rspell/index.html","id":"add-in-and-keyboard-shortcut","dir":"","previous_headings":"","what":"Add-in and keyboard shortcut","title":"Grammar Check Documents on RStudio","text":"faster use, can use package’s RStudio add-. installing package, available add-list. can also map keyboard shortcut , like Ctrl+g.","code":""},{"path":"https://rfsaldanha.github.io/rspell/index.html","id":"modify-or-just-list-the-errors","dir":"","previous_headings":"","what":"Modify or just list the errors","title":"Grammar Check Documents on RStudio","text":"possible just show errors without asking modificate selection.","code":"rspell::check_selection(ask_modify = FALSE)"},{"path":"https://rfsaldanha.github.io/rspell/reference/check_selection.html","id":null,"dir":"Reference","previous_headings":"","what":"Check current selection — check_selection","title":"Check current selection — check_selection","text":"Check grammar errors selected text recommend corrections possible.","code":""},{"path":"https://rfsaldanha.github.io/rspell/reference/check_selection.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check current selection — check_selection","text":"","code":"check_selection(ask_modify = TRUE, language = NULL)"},{"path":"https://rfsaldanha.github.io/rspell/reference/check_selection.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check current selection — check_selection","text":"ask_modify logical. TRUE, prompt shown asking alter document correction . language character. Code like en-US, fr-FR, etc. auto automatic language detection.","code":""},{"path":"https://rfsaldanha.github.io/rspell/reference/check_selection.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check current selection — check_selection","text":"object return function, expects run interactive session.","code":""},{"path":"https://rfsaldanha.github.io/rspell/reference/check_text.html","id":null,"dir":"Reference","previous_headings":"","what":"Grammar check a text — check_text","title":"Grammar check a text — check_text","text":"Grammar check text","code":""},{"path":"https://rfsaldanha.github.io/rspell/reference/check_text.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Grammar check a text — check_text","text":"","code":"check_text(text, language = \"auto\")"},{"path":"https://rfsaldanha.github.io/rspell/reference/check_text.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Grammar check a text — check_text","text":"text character. character object text check. language character. Code like en-US, fr-FR, etc. auto (default) automatic language detection.","code":""},{"path":"https://rfsaldanha.github.io/rspell/reference/check_text.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Grammar check a text — check_text","text":"tibble grammar checks.","code":""},{"path":"https://rfsaldanha.github.io/rspell/reference/check_text.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Grammar check a text — check_text","text":"","code":"check_text(\"O rato roeu a roupa do rei de roma.\", language = \"pt-BR\") #> # A tibble: 1 × 11 #>   message          shortMessage replacements offset length context      sentence #>                                             #> 1 Encontrado poss… Erro ortogr…            30      4  O rato … #> # ℹ 4 more variables: type , rule , #> #   ignoreForIncompleteSentence , contextForSureMatch  check_text(\"Bernardo climb the stairs to the castle’s ramparts.\", language = \"auto\") #> Waiting 2s for throttling delay ■■■■■■■■■■■■■■■                  #> Waiting 2s for throttling delay ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■   #> # A tibble: 1 × 11 #>   message          shortMessage replacements offset length context      sentence #>                                             #> 1 The singular pr… Agreement e…         9      5  Bernard… #> # ℹ 4 more variables: type , rule , #> #   ignoreForIncompleteSentence , contextForSureMatch "},{"path":"https://rfsaldanha.github.io/rspell/news/index.html","id":"rspell-005","dir":"Changelog","previous_headings":"","what":"rspell 0.0.5","title":"rspell 0.0.5","text":"Function check_text() now exported. Improve messages. Modify internal function names.","code":""},{"path":"https://rfsaldanha.github.io/rspell/news/index.html","id":"rspell-004","dir":"Changelog","previous_headings":"","what":"rspell 0.0.4","title":"rspell 0.0.4","text":"Improve documentation arguments assertion.","code":""},{"path":"https://rfsaldanha.github.io/rspell/news/index.html","id":"rspell-003","dir":"Changelog","previous_headings":"","what":"rspell 0.0.3","title":"rspell 0.0.3","text":"Primarily, adopt spelling language defined RStudio’s Project Options. defined, uses spelling language Global options. Verifies text size accordingly LanguageTool API rules (20KB maximum size). Ignore case looking rproj files.","code":""},{"path":"https://rfsaldanha.github.io/rspell/news/index.html","id":"rspell-002","dir":"Changelog","previous_headings":"","what":"rspell 0.0.2","title":"rspell 0.0.2","text":"Prompt modify text default choice (just press Enter). Move focus console back source. Messages improvements. query LanguageTool API selection empty. use query cache API call. Throttle requests rate accordingly LanguageTool API rules (20 requests per minute).","code":""},{"path":"https://rfsaldanha.github.io/rspell/news/index.html","id":"rspell-001","dir":"Changelog","previous_headings":"","what":"rspell 0.0.1","title":"rspell 0.0.1","text":"package now observes default project language set.","code":""},{"path":"https://rfsaldanha.github.io/rspell/news/index.html","id":"rspell-0009","dir":"Changelog","previous_headings":"","what":"rspell 0.0.0.9","title":"rspell 0.0.0.9","text":"First version, basic functions.","code":""}]