Skip to content

Commit

Permalink
pkgdown update
Browse files Browse the repository at this point in the history
  • Loading branch information
@favstats
favstats committed Jul 13, 2021
1 parent ac23538 commit 44472e9
Show file tree
Hide file tree
Showing 11 changed files with 169 additions and 153 deletions.
2 changes: 2 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
.Rproj.user
.Rproj
.Rhistory
.RData
.Ruserdata
docs
2 changes: 1 addition & 1 deletion DESCRIPTION
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Authors@R: person("Fabio", "Votta", email = "[email protected]", role = c("a
Description: Interface to the 'Perspective' API, which can be found at the following URL: <https://github.com/conversationai/perspectiveapi#perspective-comment-analyzer-api>.
The 'Perspective' API uses machine learning models to score the perceived impact a comment might have on a conversation (i.e. TOXICITY, INFLAMMATORY, etc.).
'peRspective' provides access to the API and returns tidy data frames with results of the specified machine learning model(s).
URL: https://github.com/favstats/peRspective
URL: https://favstats.github.io/peRspective, https://github.com/favstats/peRspective
BugReports: https://github.com/favstats/peRspective
Depends: R (>= 3.5.0)
License: MIT + file LICENSE
Expand Down
2 changes: 2 additions & 0 deletions NEWS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

* Fixed bug where it would sometimes not correctly match the `text_id` due to one variable being numeric. Now always outputs character.

* Updated documentation to reflect changes in the Perspective API (API key retrieval, available models, etc.).

# peRspective 0.1.0 (2019-05-17)

* Submit to CRAN
Expand Down
31 changes: 16 additions & 15 deletions README.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,21 +92,22 @@ Currently, Perspective API has production `TOXICITY` and `SEVERE_TOXICITY` attri

### Toxicity attributes

| Attribute name | Type | Description | Language |
| -------------------- | ---- | ----------- | -------- |
| `TOXICITY` | prod. | Rude, disrespectful, or unreasonable comment that is likely to make people leave a discussion. | en, fr, es, de, it, pt, ru | 6 |
| `SEVERE_TOXICITY` | prod. | A very hateful, aggressive, disrespectful comment or otherwise very likely to make a user leave a discussion or give up on sharing their perspective. This attribute is much less sensitive to comments that include positive uses of curse words, for example. A labelled dataset and details of the methodology can be found in the same toxicity dataset that is available for the toxicity attribute. | en, fr, es, de, it, pt, ru |
| `TOXICITY_FAST` | exp. | This attribute is similar to `TOXICITY`, but has lower latency and lower accuracy in its predictions. Unlike `TOXICITY`, this attribute returns summary scores as well as span scores. This attribute uses character-level n-grams fed into a logistic regression, a method that has been surprisingly effective at detecting abusive language. | en |
| `IDENTITY_ATTACK` | exp. | Negative or hateful comments targeting someone because of their identity. | en, de, it, pt, ru |
| `IDENTITY_ATTACK_EXPERIMENTAL` | exp. | &nbsp; | fr, es |
| `INSULT` | exp. | Insulting, inflammatory, or negative comment towards a person or a group of people. | en, de, it, pt, ru |
| `INSULT_EXPERIMENTAL` | exp. | &nbsp; | fr, es |
| `PROFANITY` | exp. | Swear words, curse words, or other obscene or profane language. | en, de, it, pt, ru |
| `PROFANITY_EXPERIMENTAL` | exp. | &nbsp; | fr, es |
| `THREAT` | exp. | Describes an intention to inflict pain, injury, or violence against an individual or group. | en, de, it, pt, ru |
| `THREAT_EXPERIMENTAL` | exp. | &nbsp; | fr, es |
| `SEXUALLY_EXPLICIT` | exp. |Contains references to sexual acts, body parts, or other lewd content. | en |
|`FLIRTATION` | exp. | Pickup lines, complimenting appearance, subtle sexual innuendos, etc. | en |
| Attribute name | Type | Description | Available Languages |
|------------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| `TOXICITY` | prod. | A rude, disrespectful, or unreasonable comment that is likely to make people leave a discussion. | English (en), Spanish (es), French (fr), German (de), Portuguese (pt), Italian (it), Russian (ru) |
| `TOXICITY_EXPERIMENTAL` | exp. | A rude, disrespectful, or unreasonable comment that is likely to make people leave a discussion. | Arabic (ar) |
| `SEVERE_TOXICITY` | prod. | A very hateful, aggressive, disrespectful comment or otherwise very likely to make a user leave a discussion or give up on sharing their perspective. This attribute is much less sensitive to more mild forms of toxicity, such as comments that include positive uses of curse words. | en, fr, es, de, it, pt, ru |
| `SEVERE_TOXICITY_EXPERIMENTAL` | exp. | A very hateful, aggressive, disrespectful comment or otherwise very likely to make a user leave a discussion or give up on sharing their perspective. This attribute is much less sensitive to more mild forms of toxicity, such as comments that include positive uses of curse words. | ar |
| `IDENTITY_ATTACK` | prod. | Negative or hateful comments targeting someone because of their identity. | de, it, pt, ru, en |
| `IDENTITY_ATTACK_EXPERIMENTAL` | exp. | Negative or hateful comments targeting someone because of their identity. | fr, es, ar |
| `INSULT` | prod. | Insulting, inflammatory, or negative comment towards a person or a group of people. | de, it, pt, ru, en |
| `INSULT_EXPERIMENTAL` | exp. | Insulting, inflammatory, or negative comment towards a person or a group of people. | fr, es, ar |
| `PROFANITY` | prod. | Swear words, curse words, or other obscene or profane language. | de, it, pt, ru, en |
| `PROFANITY_EXPERIMENTAL` | exp. | Swear words, curse words, or other obscene or profane language. | fr, es, ar |
| `THREAT` | prod. | Describes an intention to inflict pain, injury, or violence against an individual or group. | de, it, pt, ru, en |
| `THREAT_EXPERIMENTAL` | exp. | Describes an intention to inflict pain, injury, or violence against an individual or group. | fr, es, ar |
| `SEXUALLY_EXPLICIT` | exp. | Contains references to sexual acts, body parts, or other lewd content. | en |
| `FLIRTATION` | exp. | Pickup lines, complimenting appearance, subtle sexual innuendos, etc. | en |

### New York Times attributes

Expand Down
Loading

0 comments on commit 44472e9

Please sign in to comment.