Add get_course_analytics_student_summaries() with enhanced filtering and sorting

[Copilot]

This PR implements the requested get_course_analytics_student_summaries() function with enhanced capabilities for retrieving course-level student analytics from Canvas.

New Function Features

The new function provides significant enhancements over the existing get_student_summaries():

• Sorting: Sort results by any column (e.g., "name", "participations", "page_views")
• Filtering: Filter results to a specific student ID
• Enhanced Error Handling: Detailed HTTP status reporting and parameter validation
• Comprehensive Documentation: Usage examples and API endpoint references

Usage Examples

library(vvcanvas)

canvas <- list(api_key = "your_key", base_url = "https://your-institution.instructure.com")

# Basic usage - get all student summaries
summaries <- get_course_analytics_student_summaries(canvas, course_id = 12345)

# Sort by participation count
sorted_summaries <- get_course_analytics_student_summaries(
  canvas, 
  course_id = 12345, 
  sort_column = "participations"
)

# Get data for specific student
student_data <- get_course_analytics_student_summaries(
  canvas, 
  course_id = 12345, 
  student_id = 67890
)

# Combine sorting and pagination
page1 <- get_course_analytics_student_summaries(
  canvas, 
  course_id = 12345, 
  sort_column = "page_views", 
  per_page = 50
)

API Details

• Endpoint: GET /api/v1/courses/:course_id/analytics/student_summaries
• Parameters:
  • sort_column (optional): Column to sort by
  • student_id (optional): Filter to specific student
  • per_page: Pagination control (default: 100)
• Returns: Data frame with per-student analytics and max values for benchmarking

Changes Made

• ✅ Created R/get_course_analytics_student_summaries.R with full implementation
• ✅ Added comprehensive Roxygen documentation with usage examples
• ✅ Created manual page man/get_course_analytics_student_summaries.Rd
• ✅ Updated NAMESPACE to export the new function
• ✅ Updated _pkgdown.yml to include function under Analytics section
• ✅ Updated TODO.md with enhanced function entry
• ✅ Implemented robust parameter validation and error handling
• ✅ Ensured backward compatibility with existing package patterns

Testing

The function has been validated for:

• ✅ Correct syntax and parameter validation
• ✅ Proper URL construction with query parameters
• ✅ Error handling for invalid inputs
• ✅ Consistency with existing analytics functions

The function is production-ready and follows all established patterns in the vvcanvas package.

Fixes #30.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

• cran.r-project.org
  • Triggering command: /usr/lib/R/bin/exec/R -e install.packages(c('roxygen2',~+~'devtools'),~+~repos='REDACTED') (dns block)
• esm.ubuntu.com
  • Triggering command: /usr/lib/apt/methods/https (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to my firewall allow list

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[tin900]

@copilot use the new paginate function see other functions how to use it

[Copilot]

@copilot use the new paginate function see other functions how to use it

Updated the function to use the new paginate() function following the pattern used in other functions like get_course_students() and get_assignments(). The function now automatically retrieves all pages of data while maintaining support for the optional sort_column and student_id parameters. Commit: f242254