Data

Tools

Indexes

Applications

Experiments

Open Source Science

vvcanvas

Canvas lms api functions

https://github.com/vusaverse/vvcanvas

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (18.7%) to scientific vocabulary

Keywords

canvas canvas-lms canvas-lms-api canvasapi cran cran-r educational instructure-canvas r rstats
Last synced: 6 months ago · JSON representation

Repository

Canvas lms api functions

Basic Info
Statistics
  • Stars: 8
  • Watchers: 2
  • Forks: 2
  • Open Issues: 16
  • Releases: 2
Topics
canvas canvas-lms canvas-lms-api canvasapi cran cran-r educational instructure-canvas r rstats
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License

README.md

vvcanvas

CodeFactor R-CMD-check CRAN status The diffify page for the R package vvcanvas CRAN last month downloads CRAN last month downloads

The open source R package vvcanvas provides a convenient interface to interact with the Canvas Learning Management System (LMS) API. It allows users to authenticate, retrieve course information, fetch specific details, and perform various operations within the Canvas LMS.

Installation

You can install the vvcanvas package from GitHub using the following command:

devtools::install_github("vusaverse/vvcanvas")

It is also possible to install from CRAN:

install.packages("vvcanvas")

Features

To see which functions are available in which section based on the CANVAS LMS API structure, please refer to the reference page of the vvcanvas package. The reference page provides a comprehensive list of functions available in the package, organized by category.

Additionally, the package includes vignettes that provide more detailed information on how to use the functions in the package.

Getting Started

To begin using the vvcanvas package, you need to authenticate with the Canvas LMS API by obtaining an API key and base URL. Follow these steps to get started:

  1. Acquire an API key from your Canvas LMS instance. You may need to consult your Canvas administrator or refer to the Canvas API documentation for instructions on obtaining an API key.

  2. Once you have the API key, load the vvcanvas library and use the canvas_authenticate function to authenticate with the Canvas LMS API. Provide the API key and the base URL of your Canvas instance as parameters. Here's an example:

```R library(vvcanvas)

Replace the placeholders with your API key and base URL

apikey <- "YOURAPIKEY" baseurl <- "https://yourcanvasdomain.com/"

Authenticate with the Canvas LMS API

canvas <- canvasauthenticate(apikey, base_url)

Alternatively, you can set system variables

Set the API key and base URL as environment variables

Sys.setenv(CANVASAPIKEY = "YOURAPIKEY") Sys.setenv(CANVASBASEURL = "https://yourcanvasdomain.com/")

Authenticate with the Canvas LMS API

canvas <- canvas_authenticate()

```

With the authentication step completed, you can now utilize the various functions provided by the vvcanvas package to interact with the Canvas LMS.

In order to retrieve a dataframe with all courses you can use the following function:

```R

Pass the canvas object to the get_courses function

courses <- get_courses(canvas)

```

Canvas Analytics Project

The canvas-analytics project provides a data pipeline for extracting, aggregating, and analyzing data from the Canvas Learning Management System (LMS) using the vvcanvas package. It aims to facilitate data retrieval and analysis at student, course, and program levels, enabling data-driven insights and decision-making in education and learning analytics. Key features include:

  • Data extraction from Canvas LMS API
  • Data aggregation at different levels (student, course, program)
  • Data visualization and reporting
  • Reproducible and extensible analysis workflow

Owner

  • Name: vusaverse
  • Login: vusaverse
  • Kind: organization
  • Location: Netherlands

The vusaverse is a collection of R packages in the scope of Student Analytics.

GitHub Events

Total
  • Issues event: 9
  • Watch event: 2
  • Delete event: 1
  • Issue comment event: 15
  • Push event: 38
  • Pull request review event: 7
  • Pull request review comment event: 2
  • Pull request event: 11
  • Create event: 8
Last Year
  • Issues event: 9
  • Watch event: 2
  • Delete event: 1
  • Issue comment event: 15
  • Push event: 38
  • Pull request review event: 7
  • Pull request review comment event: 2
  • Pull request event: 11
  • Create event: 8

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 11
  • Total pull requests: 9
  • Average time to close issues: 8 days
  • Average time to close pull requests: 2 days
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 0.27
  • Average comments per pull request: 0.67
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 7
  • Pull requests: 7
  • Average time to close issues: 9 days
  • Average time to close pull requests: 3 days
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 0.14
  • Average comments per pull request: 0.43
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • tin900 (6)
  • nelis73 (5)
Pull Request Authors
  • nelis73 (5)
  • Copilot (4)
Top Labels
Issue Labels
enhancement (6) bug (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 144 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 6
  • Total maintainers: 1
cran.r-project.org: vvcanvas

'Canvas' LMS API Integration

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 144 Last month
Rankings
Forks count: 28.3%
Dependent packages count: 28.3%
Stargazers count: 34.9%
Average: 36.5%
Dependent repos count: 36.9%
Downloads: 54.0%
Maintainers (1)
t.iwan@vu.nl
Last synced: 6 months ago

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • dplyr * imports
  • htm2txt * imports
  • httr * imports
  • jsonlite * imports
  • magrittr * imports
  • purrr * imports
  • rlang * imports
  • stringr * imports
  • tidyr * imports
  • utils * imports
  • knitr * suggests
  • rmarkdown * suggests