jvcasillas / rult

rult

A simple interface to to download RU lexTALE data.
Last update: 2023-09-13

Overview

Use this package to interface with the lextale_ru repo and download data
from the server.

Installation

You can install the development version from GitHub with:

install.packages("devtools")
devtools::install_github("jvcasillas/rult")

Use

Basics

Use the download_lextale_data() function to get data from the server. You will be prompted to enter a password. Get in touch with the maintainer if you need a password. By default, the function will create a lextale folder in the working directory of your R session:

library("rult")
download_lextale_data()

If you would like to download the data to a specific location in your working directory, you can use the destination argument:

library("rult")
download_lextale_data(
  destination = "data"
)

In the example above, the lextale folder will be created inside data, which exists in the root directory.

Filtering data

You can use the apply_filter argument to select a subset of the data on the server. For example, if you only want data from 2023, you would use the following code:

library("rult")
download_lextale_data(
  destination = "data", 
  apply_filter = "year == '2023'"
)

You can filter the data using the following variables:

• ruid: A character vector containing RU ids, e.g., ‘01234567’
• course: A character vector containing SpanPort classes, e.g., ‘span102’ (see below)
• term: A character vector containing a term (‘fall’, ‘spring’, ‘summer’)
• modality: A character vector containing the modality (‘in-person’, ‘online’, ‘hybrid’)
• session: A character vector containing the session (‘beginning-of-semester’, ‘end-of-semester’)
• instructor: A character vector containing the instructors last name, e.g., ‘casillas’

Note: Filtering options work the same as standard control structures in R, e.g., "term == 'fall' & year == '2023'". Here is a full list of course options:

• span101
• span102
• span121
• span131
• span132
• span160
• span201
• span202
• span203
• span204
• span205
• span206
• span215
• span225
• span250
• span261
• span313
• span325
• span326
• span331
• span332
• span333
• span334
• span335
• span336
• span342
• span346
• span348
• span353
• span360
• span362
• span363
• span364
• span366
• span367
• span368
• span389
• span390
• span402
• span403
• span404
• span405
• span406
• span419
• span450
• span462
• span471
• span477
• span479
• span488
• span489
• span490
• span491
• span492
• span491
• span491
• span597
• span493
• span494
• span499
• span500
• graduate