Help for package BRVM

Type:

Package

Title:

Retrieve Historical Data of Companies Listed on the 'BRVM' Stock Exchange

Version:

5.3.0

Description:

Provide real-time access to data from the Regional Securities Exchange SA(https://www.brvm.org/en), commonly known as the 'BRVM' stock exchange. The goal is to facilitate data access for users of the R programming language. The package includes a variety of data that can be accessed by calling functions.

License:

MIT + file LICENSE

URL:

https://rpubs.com/Fredysessie/Readme_BRVM_Stock

Encoding:

UTF-8

Imports:

magrittr, rlang (≥ 0.4.11), tidyr, dplyr, gsheet, httr, httr2, tseries, goftest, nortest, fBasics, stringr, tibble, xml2, highcharter, xts, formattable, timeDate, rvest, lubridate

Suggests:

rmarkdown, knitr, roxygen2

VignetteBuilder:

knitr

RoxygenNote:

7.2.3

NeedsCompilation:

Packaged:

2024-02-14 00:54:19 UTC; koffi

Author:

Sessie Koffi Frederic [aut, cre, cph], Diakité Abdoul Oudouss [aut], Steven Sanderson [aut]

Maintainer:

Sessie Koffi Frederic <koffisessie@gmail.com>

Repository:

CRAN

Date/Publication:

2024-02-21 16:02:39 UTC

Pipe operator

Description

See magrittr::%>% for details.

Usage

lhs %>% rhs

Arguments

lhs

A value or the magrittr placeholder.

rhs

A function call using the magrittr semantics.

Value

The result of calling rhs(lhs).

BRVM Available Indexes

Description

It receives no argument and returns BRVM's indexes informations.

Usage

BRVM.index()

Value

A character

Author(s)

Koffi Frederic SESSIE

Examples


BRVM.index()

BRVM By Sector

Description

This function will take in the name of sector(s) and returns data for companies belonging to that/those sector(s)

Usage

BRVM_bySector(.sectors = NULL)

Arguments

.sectors

A vector of sectors you wish to have returned.

Details

This function will take in a vector of sectors provided by the end user and return a tibble.

Value

A tibble

Author(s)

Koffi Frederic SESSIE

Oudouss Diakité Abdoul

Steven P. Sanderson II, MPH

Examples


library(stringr)
library(rlang)
library(xml2)
library(rvest)
library(dplyr)

sectors <- c("Industry","Administration","PUblic service", "AUtr", "FINANCE",
            "distribution", 25)
BRVM_bySector(.sectors = sectors)
BRVM_bySector(.sectors = "All")
BRVM_bySector(.sectors = c("Other", "Agriculture"))

BRVM Capitalization

Description

It receives no argument and returns informations about BRVM capitalization

Usage

BRVM_cap()

Value

A tibble

Author(s)

Koffi Frederic SESSIE

Examples


BRVM_cap()

BRVM companies capitalization value - To get the capitalization value data of all companies listed on BRVM stock exchange

Description

This function will get the capitalization value data of all companies listed on the BVRM exchange. The function takes no parameter

Usage

BRVM_company_cap()

Value

A tibble

Author(s)

Koffi Frederic SESSIE

Examples


BRVM_company_cap()

BRVM Get info about a ticker beta, RSI, Closing, Valorisation, etc.

Description

It receives the ticker of a company or index listed on the BRVM stock exchange, Turn to upper case the input by using toupper() and returns informations about the company's RSI, Beta, Closing price, etc. .

Usage

BRVM_company_info(ticker)

Arguments

ticker

The ticker of a company

Value

A tibble

Author(s)

Koffi Frederic SESSIE

Examples

BRVM_company_info("BOAS")
BRVM_company_info("BoaM")
BRVM_company_info("BRVMAG")

BRVM Companies Rank - Get all tickers rank according to last quotation

Description

This function returns companies rank from the BRVM Bourse exchange according to their daily change (variation).

Usage

BRVM_company_rank()

Details

This function will get the rank of the companies listed on the BVRM exchange through the Rich Bourse site. The function takes no parameter

Value

"tbl_df" "tbl" "data.frame"

Author(s)

Koffi Frederic SESSIE

Oudouss Diakité Abdoul

Steven P. Sanderson II, MPH

Examples


library(httr)
#library(dplyr)
library(rvest)
BRVM_company_rank()
comp.rank <- BRVM_company_rank()
# comp.rank<-comp.rank%>%
# dplyr::arrange(desc(percent_change))
comp.rank #in case the connexion is worse it will return error

BRVM company url

Description

It receives the ticker name and return an URL

Usage

BRVM_company_url(company)

Arguments

company

is the name of the Ticker

Value

URL

Author(s)

Koffi Frederic SESSIE

Examples

BRVM_company_url("BICC")

BRVM Rank

Description

This function will take in 'Up' or 'Down' and returns respectively n results for the top or flop ranking of the BRVM tickers.

Usage

BRVM_direction(.up_or_down = "Up")

Arguments

.up_or_down

This is a character string set to "Up" It can either be 'Up' or 'Down'.

Details

This function will get any n results for the top or flop ranking of the BRVM tickers.

Value

A tibble

Author(s)

Koffi Frederic SESSIE

Oudouss Diakité Abdoul

Steven P. Sanderson II, MPH

Examples


BRVM_direction("Up")

BRVM Get - Get Ticker Data

Description

This function will get data from the Rich Bourse exchange.

Usage

BRVM_get(.symbol, .from = Sys.Date() - 365, .to = Sys.Date() - 1)

Arguments

.symbol

A vector of symbols, like: c("BICC","XOM","SlbC")

.from

A quoted start date, ie. "2020-01-01" or "2020/01/01". The date must be in ymd format "YYYY-MM-DD" or "YYYY/MM/DD".

.to

A quoted end date, ie. "2022-01-31" or "2022/01/31". The date must be in ymd format "YYYY-MM-DD" or "YYYY/MM/DD"

Details

This function will get data of the companies listed on the BVRM exchange through the Rich Bourse site. The function takes in a single parameter of .symbol The function will auto-format the tickers you input into all upper case by using toupper() The function will next make sure that the ticker passed is inside of a google spreadsheet of allowed tickers.

Value

A tibble

Author(s)

Koffi Frederic SESSIE

Oudouss Diakité Abdoul

Steven P. Sanderson II, MPH

Examples


library(lubridate)
library(rlang)
library(httr2)
library(dplyr)
library(stringr)

symbols <- c("BiCc","XOM","SlbC")
data_tbl <- BRVM_get(.symbol = symbols)
data_tbl

BRVM Get - Get BRVM stock exchange Ticker Data

Description

This function will get data from the Sikafinance exchange.

Usage

BRVM_get1(ticker = "BICC", Period = 0, from = Sys.Date() - 89, to = Sys.Date())

Arguments

ticker

A vector of ticker, like: c("BICC","XOM","SlbC", "BRvm10")

Period

Numeric number indicating time period. Valid entries are 0, 1, 5, 30, 91, and 365 representing respectively 'daily', 'one year', 'weekly', 'monthly', 'quarterly' and 'yearly'.

from

A quoted start date, ie. "2020-01-01" or "2020/01/01". The date must be in ymd format "YYYY-MM-DD" or "YYYY/MM/DD".

to

A quoted end date, ie. "2022-01-31" or "2022/01/31". The date must be in ymd format "YYYY-MM-DD" or "YYYY/MM/DD"

Details

This function will get data of the companies listed on the BVRM exchange through the sikafinance site. The function takes in a single parameter of ticker The function will auto-format the tickers you input into all upper case by using toupper()

Value

A tibble

Author(s)

Koffi Frederic SESSIE

Examples


library(lubridate)
library(rlang)
library(httr2)
library(dplyr)
library(stringr)

symbols <- c("BiCc","XOM","SlbC")
data_tbl <- BRVM_get1(ticker = symbols)
data_tbl

#From three year ago to the present

BRVM_get1("ALL INDEXES", from = Sys.Date() - 252*3, to = Sys.Date())

BRVM_get1(ticker = "BRVMAG", from = "2010-01-04", to = "2022-01-04")

BRVM_get1("ALL", Period = 0, from = "2010-01-04", to = "2022-01-04"  ) #To get daily data

BRVM_get1("BrvmAS", Period = 1 ) # To get daily data for a whole year

BRVM_get1(c("BRVMPR", "BRVMAG"), Period = 5) # To get weekly data

BRVM_get1("BRVMAG", Period = 30 ) # To get monthly data

BRVM_get1("BRVMPR", Period = 91 ) # To get quaterly data

BRVM_get1(c("brvmtr", "BiCc", "BOAS"), Period = 365 ) # To get yearly data

BRVM Get - Get BRVM indexes Data

Description

This function will get data from https://www.brvm.org/.

Usage

BRVM_index()

Details

This function will get index data from https://www.brvm.org/

Value

A tibble

Author(s)

Koffi Frederic SESSIE

Oudouss Diakité Abdoul

Steven P. Sanderson II, MPH

Examples


BRVM_index()

BRVM index stock - Given a set of indexes, return their stock data

Description

Give a set of indexes and get it/their stock data. Use BRVM.index() function to know all available indexes

Usage

BRVM_index_stock(
  .ticker = "BRVM10",
  Period = 0,
  from = Sys.Date() - 89,
  to = Sys.Date()
)

Arguments

.ticker

Must be at least one index between c("BRVM10","BRVMAG","BRVMC","BRVMAS","BRVMDI","BRVMFI", "BRVMIN", "BRVMSP", "BRVMTR")

Period

Numeric number indicating time period. Valid entries are 0, 1, 5, 30, 91, and 365 representing respectively ‘daily’, 'one year', ‘weekly’, ‘monthly’, ‘quarterly’ and ‘yearly’ .

from

A quoted start date, ie. "2020-01-01" or "2020/01/01". The date must be in ymd format "YYYY-MM-DD" or "YYYY/MM/DD".

to

A quoted end date, ie. "2022-05-20" or "2022/05/20". The date must be in ymd format "YYYY-MM-DD" or "YYYY/MM/DD"

Value

"data.frame"

Author(s)

Koffi Frederic SESSIE

Examples


BRVM_index_stock(.ticker = "BRVMAG", from = "2018-01-04", to = "2022-01-04")

BRVM_index_stock("BRVM10", Period = 0, from = "2021-01-04", to = "2022-01-04"  ) #To get daily data

BRVM_index_stock("BrvmAS", Period = 1 ) # To get daily data for a whole year

BRVM_index_stock("BRVM10", Period = 5, from = "2021-01-04", to = "2022-01-04") # To get weekly data

BRVM_index_stock("BRVMAG", Period = 30 ) # To get monthly data

BRVM_index_stock("BRVM10", Period = 91 ) # To get quaterly data

BRVM_index_stock("brvmtr", Period = 365 ) # To get yearly data

BRVM MARKET ACTIVITIES

Description

It receives no argument and returns informations about BRVM market activities

Usage

BRVM_market_activity()

Value

A tibble

Author(s)

Koffi Frederic SESSIE

Examples


BRVM_market_activity()

BRVM PLOT

Description

This function will get Ticker(s) data and then plot it.

Usage

BRVM_plot(
  .company,
  from = Sys.Date() - 365,
  to = Sys.Date() - 1,
  up.col = "darkgreen",
  down.col = "red"
)

Arguments

.company

is the Ticker(s) name(s)

from

A quoted start date, ie. "2020-01-01" or "2020/01/01". The date must be in ymd format "YYYY-MM-DD" or "YYYY/MM/DD".

to

A quoted end date, ie. "2022-01-31" or "2022/01/31". The date must be in ymd format "YYYY-MM-DD" or "YYYY/MM/DD"

up.col

is the up color

down.col

is down color

Value

An interactive chart

Author(s)

Koffi Frederic SESSIE

Examples


library(highcharter)
library(lubridate)
library(rlang)
library(httr2)
library(dplyr)
library(stringr)
library(xts)

BRVM_plot("BICC")

# You can change the up and down colors as follow
BRVM_plot("BICC", up.col = "blue", down.col = "pink")

# Plot the closing price of a group of 3 tickers
BRVM_plot(c("BICC","ETIT", "SNTS"))

BRVM_rank - Get top or flop data of BRVM stock exchange

Description

It receives "top" or "flop" and a number 'n' and returns table of companies classification

Usage

BRVM_rank(top_or_flop, n = 10)

Arguments

top_or_flop

Choose between "top" or "flop"

n

is the number of companies in the classification

Value

"tbl_df" "tbl" "data.frame"

Author(s)

Koffi Frederic SESSIE

Oudouss Diakité Abdoul

Steven P. Sanderson II, MPH

Examples


BRVM_rank("top", 15)
BRVM_rank("flop", 5)

BRVM Official Quotation reviews

Description

This function receives as input a day of the week (working day) and returns the official quotation revews of that day.

Usage

BRVM_stock_market(.weekday)

Arguments

.weekday

A quoted date, ie. "2022-01-31" or "2022/01/31". The date must be in ymd format "YYYY-MM-DD" or "YYYY/MM/DD". Must not be a weekend or a holiday

Value

A formatabble table

Author(s)

Koffi Frederic SESSIE

Examples


library(httr)
library(lubridate)
library(rvest)
library(timeDate)
library(formattable)
library(stringr)

BRVM_stock_market("2022-04-25")
BRVM_stock_market("2021-03-25")

BRVM ticker description - BRVM ticker information

Description

It receives no argument and returns informations about BRVM exchange companies.

Usage

BRVM_ticker_desc()

Details

This function gives many informations about each ticker, his full name, sector and his country

Value

A tibble

Author(s)

Koffi Frederic SESSIE

Oudouss Diakité Abdoul

Steven P. Sanderson II, MPH

Examples


BRVM_ticker_desc()

BRVM Tickers - Information about listed companies on BRVM Stock exchange

Description

It receives no argument and returns two informations about BRVM exchange companies (ticker and company name).

Usage

BRVM_tickers()

Value

A tibble

Author(s)

Koffi Frederic SESSIE

Oudouss Diakité Abdoul

Steven P. Sanderson II, MPH

Examples


BRVM_tickers()
ticks <- BRVM_tickers()
dput(ticks$Ticker) ## Returns the name of all tickers

BRVM traded value - To get the traded volume value data of all companies listed on BRVM stock exchange

Description

This function will get the traded volume value data of all companies listed on the BVRM exchange. The function takes no parameter

Usage

BRVM_traded_val()

Value

A tibble

Author(s)

Koffi Frederic SESSIE

Examples


BRVM_traded_val()

Company capitalization - To know the capitalization of a given company

Description

It receives one company listed on the BRVM stock exchange, Turn to upper case your input by using toupper() and returns informations about the company's capitalization

Usage

company_cap(company)

Arguments

company

The name of company listed on the BRVM stock exchange

Value

"character"

Author(s)

Koffi Frederic SESSIE

Examples


library(rvest)

company_cap("BICC")
company_cap("ontbf")

Company's country - To know the country of a given company

Description

It receives one company listed on the BRVM stock exchange, Turn to upper case your input by using toupper() and returns informations about the company's country.

Usage

company_country(company)

Arguments

company

The name of company listed on the BRVM stock exchange

Value

"character"

Author(s)

Koffi Frederic SESSIE

Examples


company_country("BICC")
company_country("SNTS")

BRVM get company rank - Get a ticker rank according to brvm quote

Description

This function returns the given company rank from the BRVM stock exchange according to their daily change (variation). It uses BRVM_company_rank() to show all copanies rank before filtering the company we give as input

Usage

company_nbrank(.company)

Arguments

.company

The company name

Details

This function will get the rank of one companies listed on the BVRM exchange through the Rich Bourse site. The function takes as parameter the name of company listed on BRVM

Value

"character"

Author(s)

Koffi Frederic SESSIE

Oudouss Diakité Abdoul

Steven P. Sanderson II, MPH

Examples


library(dplyr)
company_nbrank("BICC")
company_nbrank("SNTS")

Company's sector - To know the sector of a given company

Description

It receives one company listed on the BRVM stock exchange, Turn to upper case your input by using toupper() and returns informations about the company's sector.

Usage

company_sector(company)

Arguments

company

The name of company listed on the BRVM stock exchange

Value

"character"

Author(s)

Koffi Frederic SESSIE

Examples

company_sector("BICC")
company_sector("SNTS")

Brvm Company traded volume value - To know the traded volume value of each company

Description

It receives one company listed on the BRVM stock exchange, Turn to upper case the input by using toupper() and returns informations about the company's traded value

Usage

company_traded_val(company)

Arguments

company

The name of company listed on the BRVM stock exchange

Value

"character"

Author(s)

Koffi Frederic SESSIE

Examples


company_traded_val("ETIT")
company_traded_val("ontbf")

Normality test with univariate data

Description

Performs different types of normality test.

Usage

normality_test(x, type.test)

Arguments

x

a numeric vector or time series..

type.test

character such as "Anderson-Darling","Shapiro-Wilk","Jarque Bera","Cramer-von Mises","Shapiro-Francia","Lilliefors (Kolmogorov-Smirnov)","Pearson chi-square", "Agostino".

Value

a number that indicates the P-value of the normality test

Author(s)

Koffi Frederic SESSIE

Examples


library(goftest)
library(tseries)
library(nortest)
library(fBasics)

# one and a half week stock index
# data including a weekend
y <-ts(c(5353.08,5409.24,5315.57,5270.53, 5211.66,NA,NA,5160.80,5172.37,5160.80,5172.37))

normality_test(y ,"Shapiro-Wilk")

my_data <- BRVM_get("snts", .from = "2020-02-05", .to = "2022-02-05" )
normality_test((my_data$Close), "Agostino")
normality_test((my_data$Close[1:50]), "Jarque Bera")

Stationarity test with univariate data

Description

Performs different types of stationarity test.

Usage

stationarity_test(x, type.test)

Arguments

x

a numeric vector or time series.

type.test

character such as "Box-Pierce and Ljung-Box","Kwiatkowski-Phillips-Schmidt-Shin (KPSS)", "Augmented Dickey-Fuller Test (ADF)", "Phillips-Perron Unit Root Test"

Value

a number that indicates the P-value of the stationarity test

Author(s)

Koffi Frederic SESSIE

Examples


library(tseries)

# one and a half week stock index
# data including a weekend
y <-ts(c(5353.08,5409.24,5315.57,5270.53, 5211.66,NA,NA,5160.80,5172.37,5160.80,5172.37))

stationarity_test(y, "Box-Pierce and Ljung-Box")

Tidy eval helpers

Description

This page lists the tidy eval tools reexported in this package from rlang. To learn about using tidy eval in scripts and packages at a high level, see the dplyr programming vignette and the ggplot2 in packages vignette. The Metaprogramming section of Advanced R may also be useful for a deeper dive.

The tidy eval operators ⁠{{⁠, ⁠!!⁠, and ⁠!!!⁠ are syntactic constructs which are specially interpreted by tidy eval functions. You will mostly need ⁠{{⁠, as ⁠!!⁠ and ⁠!!!⁠ are more advanced operators which you should not have to use in simple cases.

The curly-curly operator ⁠{{⁠ allows you to tunnel data-variables passed from function arguments inside other tidy eval functions. ⁠{{⁠ is designed for individual arguments. To pass multiple arguments contained in dots, use ... in the normal way.
```
my_function <- function(data, var, ...) {
  data %>%
    group_by(...) %>%
    summarise(mean = mean({{ var }}))
}
```
enquo() and enquos() delay the execution of one or several function arguments. The former returns a single expression, the latter returns a list of expressions. Once defused, expressions will no longer evaluate on their own. They must be injected back into an evaluation context with ⁠!!⁠ (for a single expression) and ⁠!!!⁠ (for a list of expressions).
```
my_function <- function(data, var, ...) {
  # Defuse
  var <- enquo(var)
  dots <- enquos(...)

  # Inject
  data %>%
    group_by(!!!dots) %>%
    summarise(mean = mean(!!var))
}
```
In this simple case, the code is equivalent to the usage of ⁠{{⁠ and ... above. Defusing with enquo() or enquos() is only needed in more complex cases, for instance if you need to inspect or modify the expressions in some way.
The .data pronoun is an object that represents the current slice of data. If you have a variable name in a string, use the .data pronoun to subset that variable with [[.
```
my_var <- "disp"
mtcars %>% summarise(mean = mean(.data[[my_var]]))
```

Another tidy eval operator is ⁠:=⁠. It makes it possible to use glue and curly-curly syntax on the LHS of =. For technical reasons, the R language doesn't support complex expressions on the left of =, so we use ⁠:=⁠ as a workaround.

my_function <- function(data, var, suffix = "foo") {
  # Use `{{` to tunnel function arguments and the usual glue
  # operator `{` to interpolate plain strings.
  data %>%
    summarise("{{ var }}_mean_{suffix}" := mean({{ var }}))
}

Many tidy eval functions like dplyr::mutate() or dplyr::summarise() give an automatic name to unnamed inputs. If you need to create the same sort of automatic names by yourself, use as_label(). For instance, the glue-tunnelling syntax above can be reproduced manually with:
```
my_function <- function(data, var, suffix = "foo") {
  var <- enquo(var)
  prefix <- as_label(var)
  data %>%
    summarise("{prefix}_mean_{suffix}" := mean(!!var))
}
```
Expressions defused with enquo() (or tunnelled with ⁠{{⁠) need not be simple column names, they can be arbitrarily complex. as_label() handles those cases gracefully. If your code assumes a simple column name, use as_name() instead. This is safer because it throws an error if the input is not a name as expected.

Value

"tibble"

Pipe operator

Description

Usage

Arguments

Value

BRVM Available Indexes

Description

Usage

Value

Author(s)

See Also

Examples

BRVM By Sector

Description

Usage

Arguments

Details

Value

Author(s)

See Also

Examples

BRVM Capitalization

Description

Usage

Value

Author(s)

See Also

Examples

BRVM companies capitalization value - To get the capitalization value data of all companies listed on BRVM stock exchange

Description

Usage

Value

Author(s)

See Also

Examples

BRVM Get info about a ticker beta, RSI, Closing, Valorisation, etc.

Description

Usage

Arguments

Value

Author(s)

See Also

Examples

BRVM Companies Rank - Get all tickers rank according to last quotation

Description

Usage

Details

Value

Author(s)

See Also

Examples

BRVM company url

Description

Usage

Arguments

Value

Author(s)

See Also

Examples

BRVM Rank

Description

Usage

Arguments

Details

Value

Author(s)

Examples

BRVM Get - Get Ticker Data

Description

Usage

Arguments

Details

Value

Author(s)

See Also

Examples

BRVM Get - Get BRVM stock exchange Ticker Data

Description

Usage

Arguments