Package 'proustr'

Title: Tools for Natural Language Processing in French
Description: Tools for Natural Language Processing in French and texts from Marcel Proust's collection "A La Recherche Du Temps Perdu". The novels contained in this collection are "Du cote de chez Swann ", "A l'ombre des jeunes filles en fleurs","Le Cote de Guermantes", "Sodome et Gomorrhe I et II", "La Prisonniere", "Albertine disparue", and "Le Temps retrouve".
Authors: Colin Fay [aut, cre]
Maintainer: Colin Fay <[email protected]>
License: MIT + file LICENSE
Version: 0.4.0
Built: 2024-11-12 02:40:05 UTC
Source: https://github.com/colinfay/proustr

Help Index


Marcel Proust's novel "Albertine disparue"

Description

A dataset containing Marcel Proust's "Albertine disparue". This text has been downloaded from WikiSource.

Usage

albertinedisparue

Format

A tibble with text, book, volume, and year

Source

<https://fr.wikisource.org/wiki/Albertine_disparue>


Marcel Proust's novel "À l’ombre des jeunes filles en fleurs"

Description

A dataset containing Marcel Proust's "À l’ombre des jeunes filles en fleurs". This text has been downloaded from WikiSource.

Usage

alombredesjeunesfillesenfleurs

Format

A tibble with text, book, volume, and year

Source

<https://fr.wikisource.org/wiki/


Marcel Proust's novel "Du côté de chez Swann"

Description

A dataset containing Marcel Proust's "Du côté de chez Swann". This text has been downloaded from WikiSource.

Usage

ducotedechezswann

Format

A tibble with text, book, volume, and year

Source

<https://fr.wikisource.org/wiki/Du_c


Marcel Proust's novel "La Prisonnière"

Description

A dataset containing Marcel Proust's "La prisonnière". This text has been downloaded from WikiSource.

Usage

laprisonniere

Format

A tibble with text, book, volume, and year

Source

<https://fr.wikisource.org/wiki/La_Prisonni


Marcel Proust's novel "Le côté de Guermantes"

Description

A dataset containing Marcel Proust's "À l’ombre des jeunes filles en fleurs". This text has been downloaded from WikiSource.

Usage

lecotedeguermantes

Format

A tibble with text, book, volume, and year

Source

<https://fr.wikisource.org/wiki/Le_C


Marcel Proust's novel "Le temps retrouvé"

Description

A dataset containing Marcel Proust's "Le temps retrouvé". This text has been downloaded from WikiSource.

Usage

letempretrouve

Format

A tibble with text, book, volume, and year.

Source

<https://fr.wikisource.org/wiki/Le_Temps_retrouv


Detect french days

Description

Detect the name of the days (in French)

Usage

pr_detect_days(df, col)

Arguments

df

a dataframe

col

the column containing the text

Value

a tibble with the number of days detected by the algo

Examples

a <- data.frame(jours = c("C'est lundi 1er mars et mardi 2", 
"Et mercredi 3", "Il est revenu jeudi."))
pr_detect_days(a, jours)

Detect french months

Description

Detect the name of the months (in French)

Usage

pr_detect_months(df, col)

Arguments

df

a dataframe

col

the column containing the text

Value

a tibble with the number of days detected by the algo

Examples

a <- data.frame(month = c("C'est lundi 1er mars et mardi 2", 
"Et mercredi 3", "Il est revenu en juin."))
pr_detect_months(a, month)

Detect French pronoums

Description

Detect the pronouns from a text (in French)

Usage

pr_detect_pro(df, col, verbose = FALSE)

Arguments

df

a dataframe

col

the column containing the text

verbose

wether or not to return the list of pronouns. Defaults is FALSE

Details

The shortcuts in the pronoun col stand for:

pps: first person singular (première personne du singulier)

dps: second person singular (deuxième personne du singulier)

tps: third person singular (troisième personne du singulier)

ppp: first person plural (première personne du pluriel)

dpp: second person singular (deuxième personne du pluriel)

tpp: third person singular (troisième personne du pluriel)

Value

a tibble with the detected pronouns

Examples

library(proustr)
a <- proust_books()[1,] 
pr_detect_pro(a, text, verbose = TRUE)
pr_detect_pro(a, text)

Remove non alnum elements

Description

Remove non alnum elements

Usage

pr_keep_only_alnum(text, replacement = " ")

Arguments

text

a vector

replacement

what to replace the non alnum with. Defaut is " ".

Value

a vector

Examples

pr_keep_only_alnum("neuilly-en-thelle")

Normalize punctuation

Description

Normalize a text written with usual french punctuation

Usage

pr_normalize_punc(df, col)

Arguments

df

a dataframe

col

the column to normalize

Value

a tibble with normalized text

Examples

a <- proustr::albertinedisparue[1:20,]
pr_normalize_punc(albertinedisparue, text)

Stem a dataframe containing a column with sentences

Description

Implementation of the SnowballC stemmer. Note that punctuation and capital letters are removed when processing.

Usage

pr_stem_sentences(df, col, language = "french")

Arguments

df

the data.frame containing the text

col

the column with the text

language

the language of the text. Defaut is french. See SnowballC::getStemLanguages() function for a list of supported languages.

Value

a tibble

Examples

a <- proustr::laprisonniere[1:10,]
pr_stem_sentences(a, text)

Stem a dataframe containing a column with words

Description

Implementation of the SnowballC stemmer. Note that punctuation and capitals letters are also removed.

Usage

pr_stem_words(df, col, language = "french")

Arguments

df

the data.frame containing the sentences

col

the column with the sentences

language

the language of the words Defaut is french. See SnowballC::getStemLanguages() function for a list of supported languages.

Value

a tibble

Examples

a <- data.frame(words = c("matin", "heure", "fatigué","sonné","lois", "tests","fusionner"))
pr_stem_words(a, words)

Remove accents

Description

Remove accents from a character vector

Usage

pr_unacent(text)

Arguments

text

a vector

Value

a vector

Examples

pr_unacent("du chêne")

Tidy data frame of Marcel Proust's 7 novels from La Recherche

Description

Returns a tidy tibble of Marcel Proust's 7 novels from À la recherche du temps perdu. The tibble contains four columns: text, book, volume and year.

Usage

proust_books()

Value

A tibble with four columns: text, book, volume and year.

Examples

#Create the tibble 
proust <- proust_books()

Characters from "À la recherche du temps perdu"

Description

A dataset containing Marcel Proust's characters from "À la recherche du temps perdu" and their frequency in each book. This dataset has been downloaded from proust-personnages.

Usage

proust_char

Format

A tibble with their name

Source

http://proust-personnages.fr/?page_id=10254


Characters from Proust Books

Description

Returns a tidy data frame of Marcel Proust's characters.

Usage

proust_characters()

Value

A tibble

Source

http://proust-personnages.fr/

Examples

#Creates the tibble 
proust <- proust_characters()

Create a Random Proust extract

Description

Create your own flavor of Proust with this random extractor.

Usage

proust_random(count = 1, collapse = TRUE)

Arguments

count

the number of line you want to randomly extract and paste.

collapse

if FALSE, the output will be a tibble. Default is TRUE, a character vector.

Value

a character vector

Examples

proust_random(4)

Old sentiment lexicon This function has been deprecated, and will be in next proustr version. See the rfeel package now: http://github.com/ColinFay/rfeel

Description

Old sentiment lexicon This function has been deprecated, and will be in next proustr version. See the rfeel package now: http://github.com/ColinFay/rfeel

Usage

proust_sentiments(type = c("polarity", "score"))

Arguments

type

For backward compatibility

Value

a tibble


Stop Words

Description

Stop words concatenated from various web sources.

Usage

proust_stopwords()

Value

a tibble with stopwords

Source

https://raw.githubusercontent.com/stopwords-iso/stopwords-fr/master/stopwords-fr.txt

Examples

proust_stopwords()

Marcel Proust's novel "Sodome et Gomorrhe"

Description

A dataset containing Marcel Proust's "Sodom et Gomorrhe". This text has been downloaded from WikiSource.

Usage

sodomeetgomorrhe

Format

A tibble with text, book, volume, and year

Source

<https://fr.wikisource.org/wiki/Sodome_et_Gomorrhe>


Stopwords

Description

ISO stopwords

Usage

stop_words

Format

A tibble

Source

https://raw.githubusercontent.com/stopwords-iso/stopwords-iso/master/stopwords-iso.json