Frosts

pandas-inspired Excel scripting for Office Scripts


Project maintained by JoeyRussoniello Hosted on GitHub Pages — Theme by mattgraham

⚙️ Installation Instructions

Implementing frosts in your office scripts is incredibly easy! Either:

Unfortunately the current Office Scripts engine does not support imports, so a frost_template file will have to be copied for each project until this feature gets added

🚀 Getting Started

The agreed alias for frosts fr to follow pandas convention, so loading frosts as fr is assumed standard practice for all of the frosts documentation.

let frosts = fr;

This line of code is built-in for frosts.osts and frosts.ts already.

Create a DataFrame by using one of the frost helper functions

const selectedSheeet = workbook.getActiveWorksheet();
// Create a df from the entire used range in selectedSheet
let df_from_sheet = fr.read_sheet(selectedSheet);

//Create a df from a specified range;
let df_from_range = fr.read_range(selectedSheet.getRange("A1:D100"));

//Create a df from a JSON-encoded array
let df_from_json = fr.read_json(json_string);

//Create a df from Comma Separated Values
let df_from_csv = fr.read_csv(csv_string);

See More Information on creating DataFrames with helper methods in the Reading Data

Or by passing in a 2D array where the first row is the header:

const data = [
  ["Name", "Age", "Score"],
  ["Alice", 25, 88],
  ["Bob", 30, 92],
  ["Charlie", 28, 79],
];

const df = new frosts.DataFrame(data);

Now that you’ve started a .osts file, and know the basics of initializing a DataFrame, we can read data from a source