Browse Source

cleaned up README

master
boB Rudis 3 years ago
parent
commit
a6573b878f
No known key found for this signature in database GPG Key ID: 1D7529BE14E2BBA9
  1. 13
      README.Rmd
  2. 132
      README.md

13
README.Rmd

@ -25,7 +25,7 @@ hrbrpkghelpr::describe_ingredients()
## Installation ## Installation
NOTE: This requires `{swiftr}`. NOTE: This requires [{swiftr}](https://github.com/hrbrmstr/swiftr).
```{r install-ex, results='asis', echo=FALSE, cache=FALSE} ```{r install-ex, results='asis', echo=FALSE, cache=FALSE}
hrbrpkghelpr::install_block() hrbrpkghelpr::install_block()
@ -42,7 +42,16 @@ packageVersion("swiftspeech")
``` ```
```{r ex01} ```{r ex01}
parts_of_speech("The comm wasn't working. Feeling increasingly ridiculous, he pushed the button for the 1MC channel several more times. Nothing. He opened his eyes and saw that all the lights on the panel were out. Then he turned around and saw that the lights on the refrigerator and the ovens were out. It wasn’t just the coffeemaker; the entire galley was in open revolt. Holden looked at the ship name, Rocinante, newly stenciled onto the galley wall, and said, Baby, why do you hurt me when I love you so much?") tibble::as_tibble(parts_of_speech(paste0(c(
"The comm wasn't working. Feeling increasingly ridiculous, he pushed",
"the button for the 1MC channel several more times. Nothing. He opened",
"his eyes and saw that all the lights on the panel were out. Then he",
"turned around and saw that the lights on the refrigerator and the",
"ovens were out. It wasn’t just the coffeemaker; the entire galley was",
"in open revolt. Holden looked at the ship name, Rocinante, newly",
"stenciled onto the galley wall, and said, Baby, why do you hurt me",
"when I love you so much?"
), collapse = " ")))
``` ```
## swiftspeech Metrics ## swiftspeech Metrics

132
README.md

@ -30,7 +30,7 @@ The following functions are implemented:
## Installation ## Installation
NOTE: This requires `{swiftr}`. NOTE: This requires [{swiftr}](https://github.com/hrbrmstr/swiftr).
``` r ``` r
remotes::install_git("https://git.rud.is/hrbrmstr/swiftspeech.git") remotes::install_git("https://git.rud.is/hrbrmstr/swiftspeech.git")
@ -38,6 +38,8 @@ remotes::install_git("https://git.rud.is/hrbrmstr/swiftspeech.git")
remotes::install_gitlab("hrbrmstr/swiftspeech") remotes::install_gitlab("hrbrmstr/swiftspeech")
# or # or
remotes::install_bitbucket("hrbrmstr/swiftspeech") remotes::install_bitbucket("hrbrmstr/swiftspeech")
# or
remotes::install_github("hrbrmstr/swiftspeech")
``` ```
NOTE: To use the ‘remotes’ install options you will need to have the NOTE: To use the ‘remotes’ install options you will need to have the
@ -54,112 +56,42 @@ packageVersion("swiftspeech")
``` ```
``` r ``` r
parts_of_speech("The comm wasn't working. Feeling increasingly ridiculous, he pushed the button for the 1MC channel several more times. Nothing. He opened his eyes and saw that all the lights on the panel were out. Then he turned around and saw that the lights on the refrigerator and the ovens were out. It wasn’t just the coffeemaker; the entire galley was in open revolt. Holden looked at the ship name, Rocinante, newly stenciled onto the galley wall, and said, Baby, why do you hurt me when I love you so much?") tibble::as_tibble(parts_of_speech(paste0(c(
## name tag "The comm wasn't working. Feeling increasingly ridiculous, he pushed",
## 1 The Determiner "the button for the 1MC channel several more times. Nothing. He opened",
## 2 comm Noun "his eyes and saw that all the lights on the panel were out. Then he",
## 3 was Verb "turned around and saw that the lights on the refrigerator and the",
## 4 n't Adverb "ovens were out. It wasn’t just the coffeemaker; the entire galley was",
## 5 working Verb "in open revolt. Holden looked at the ship name, Rocinante, newly",
## 6 Feeling Verb "stenciled onto the galley wall, and said, Baby, why do you hurt me",
## 7 increasingly Adverb "when I love you so much?"
## 8 ridiculous Adjective ), collapse = " ")))
## 9 he Pronoun ## # A tibble: 92 x 2
## 10 pushed Verb ## name tag
## 11 the Determiner ## <chr> <chr>
## 12 button Noun ## 1 The Determiner
## 13 for Preposition ## 2 comm Noun
## 14 the Determiner ## 3 was Verb
## 15 1MC OtherWord ## 4 n't Adverb
## 16 channel Noun ## 5 working Verb
## 17 several Adjective ## 6 Feeling Verb
## 18 more Adverb ## 7 increasingly Adverb
## 19 times Noun ## 8 ridiculous Adjective
## 20 Nothing Noun ## 9 he Pronoun
## 21 He Pronoun ## 10 pushed Verb
## 22 opened Verb ## # … with 82 more rows
## 23 his Determiner
## 24 eyes Noun
## 25 and Conjunction
## 26 saw Verb
## 27 that Determiner
## 28 all Adverb
## 29 the Determiner
## 30 lights Noun
## 31 on Preposition
## 32 the Determiner
## 33 panel Noun
## 34 were Verb
## 35 out Adverb
## 36 Then Adverb
## 37 he Pronoun
## 38 turned Verb
## 39 around Adverb
## 40 and Conjunction
## 41 saw Verb
## 42 that Preposition
## 43 the Determiner
## 44 lights Noun
## 45 on Preposition
## 46 the Determiner
## 47 refrigerator Noun
## 48 and Conjunction
## 49 the Determiner
## 50 ovens Noun
## 51 were Verb
## 52 out Adverb
## 53 It Pronoun
## 54 was Verb
## 55 n’t Adverb
## 56 just Adverb
## 57 the Determiner
## 58 coffeemaker Noun
## 59 the Determiner
## 60 entire Adjective
## 61 galley Noun
## 62 was Verb
## 63 in Preposition
## 64 open Adjective
## 65 revolt Noun
## 66 Holden Noun
## 67 looked Verb
## 68 at Preposition
## 69 the Determiner
## 70 ship Noun
## 71 name Noun
## 72 Rocinante Noun
## 73 newly Adverb
## 74 stenciled Verb
## 75 onto Preposition
## 76 the Determiner
## 77 galley Noun
## 78 wall Noun
## 79 and Conjunction
## 80 said Verb
## 81 Baby Noun
## 82 why Pronoun
## 83 do Verb
## 84 you Pronoun
## 85 hurt Verb
## 86 me Pronoun
## 87 when Pronoun
## 88 I Pronoun
## 89 love Verb
## 90 you Pronoun
## 91 so Adverb
## 92 much Adverb
``` ```
## swiftspeech Metrics ## swiftspeech Metrics
| Lang | \# Files | (%) | LoC | (%) | Blank lines | (%) | \# Lines | (%) | | Lang | \# Files | (%) | LoC | (%) | Blank lines | (%) | \# Lines | (%) |
|:-------------|---------:|-----:|----:|-----:|------------:|-----:|---------:|-----:| |:-------------|---------:|-----:|----:|-----:|------------:|-----:|---------:|-----:|
| Swift | 1 | 0.07 | 31 | 0.24 | 9 | 0.13 | 0 | 0.00 | | Swift | 1 | 0.07 | 31 | 0.21 | 9 | 0.13 | 0 | 0.00 |
| C | 1 | 0.07 | 13 | 0.10 | 4 | 0.06 | 1 | 0.01 | | Rmd | 1 | 0.07 | 18 | 0.12 | 17 | 0.25 | 31 | 0.32 |
| Rmd | 1 | 0.07 | 9 | 0.07 | 17 | 0.25 | 31 | 0.32 | | C | 1 | 0.07 | 13 | 0.09 | 4 | 0.06 | 1 | 0.01 |
| R | 3 | 0.21 | 8 | 0.06 | 2 | 0.03 | 16 | 0.17 | | R | 3 | 0.21 | 8 | 0.05 | 2 | 0.03 | 16 | 0.17 |
| C/C++ Header | 1 | 0.07 | 4 | 0.03 | 2 | 0.03 | 0 | 0.00 | | C/C++ Header | 1 | 0.07 | 4 | 0.03 | 2 | 0.03 | 0 | 0.00 |
| SUM | 7 | 0.50 | 65 | 0.50 | 34 | 0.50 | 48 | 0.50 | | SUM | 7 | 0.50 | 74 | 0.50 | 34 | 0.50 | 48 | 0.50 |
clock Package Metrics for swiftspeech clock Package Metrics for swiftspeech

Loading…
Cancel
Save