learningChart: learningChart

View source: R/learningChart.R

learningChartR Documentation

learningChart

Description

Make a GP Learning Chart. Will also run upload_assets() when it's done.

Usage

learningChart(
  WD = "?",
  caption = NA,
  captionN = FALSE,
  centralText = NA,
  quotedTitle = NA,
  centralTextSize = 3.5,
  saveFile = TRUE,
  destFolder,
  fileName = "GP-Learning-Chart",
  dpi = 200,
  showPlot = TRUE,
  ...
)

Arguments

WD

working directory; default=getwd(); if "?" supplied, will invoke pick_lesson(). The basename of this working directory will then be used to find a match in the gp-lessons git project folder by calling get_wd_git(). It's a little roundabout, but is consistent with lookups centering on the Google Drive project working directory.

caption

quoted text you want to go at the bottom of the chart

captionN

T/F, add the range of the number of standards per grade used to make the plot to caption? default=FALSE

centralText

specify grades the chart is for; by default pulls most common gradeBand from compiledAlignment (e.g. "grades⁠\\n⁠5-6")

quotedTitle

the quoted title used to attribute the learning chart (e.g. Knowledge and skills taught by 'quotedTitle')

centralTextSize

multiplier for font size of centralText

saveFile

T/F, save file or just print to screen?

destFolder

where do you want to save the folder; by default in the "assets/learningPlots" folder, 1 level up from the working directory

fileName

expects "somefilename" (file extension will be ignored)

dpi

what resolution would you like the output in dots per inch? 300 by default

showPlot

plot to screen or just save to file? default=T

...

other arguments passed to png

Value

the learning chart plot object (grid format); Result can be plotted with grid::grid.draw(result). The chart file is saved to assets/GP_Learning_Chart.png by default


galacticpolymath/GPpub documentation built on April 5, 2025, 6:04 p.m.