index_by_segment_get: Get B3 indexes available

View source: R/scraper-indexes.R

index_by_segment_getR Documentation

Get B3 indexes available

Description

Gets B3 indexes available.

Usage

index_by_segment_get(index_name, cache_folder = cachedir(), do_cache = TRUE)

Arguments

index_name

a string with the index name

cache_folder

Location of cache folder (default = cachedir())

do_cache

Whether to use cache or not (default = TRUE)

Value

A dataframe with the index stocks, their weights, segments and positions.

Examples

## Not run: 
index_by_segment_get("IBOV")

## End(Not run)

rb3 documentation built on April 14, 2023, 5:10 p.m.