esmtools (version 1.0.1)

folrows: Extract Following Rows from a Dataframe

Description

The folrows() function extracts a specified number of consecutive rows, including the starting row, from a dataframe. Rows are selected consecutively from randomly chosen starting positions. The function ensures that the selected rows fall within the valid row range of the dataframe.

Usage

folrows(.data, n = 5, nb_sample = 1)

Value

A dataframe containing the consecutive rows extracted from the randomly chosen starting positions.

Arguments

.data

The dataframe from which rows are to be extracted.

n

The number of consecutive rows to be extracted, including the starting row. Default is 5.

nb_sample

The number of random starting positions to be sampled. Default is 1.

Examples

# Extract 3 consecutive rows starting from a random position in the dataset
folrows(esmdata_sim, n = 3)

# Extract 4 consecutive rows starting from 2 random positions in a custom dataframe
folrows(esmdata_sim, n = 4, nb_sample = 2)