PRISM Documentation: Package Version Page
Getting Started
The Package Version page provides comprehensive information about a specific version of an R package. This is PRISM’s most detailed view, offering everything from basic package information to complex dependency trees and interactive documentation browsing.
Quick Actions:
- 📚 Browse documentation - Access README, vignettes, and changelogs in the embedded viewer
- 🔗 Switch versions - Use the version dropdown to explore different package versions
- 🌳 Explore dependencies - View dependency trees and package relationships
- 🔍 Check edition availability - See where this version and other versions of this package are available
- ❤️ Save as favorite - Mark packages for quick future access
- 📖 Open external docs - Launch full documentation in a new window
Getting to Package Version Pages
Page Header
Package Title Section
The header provides essential package identification and navigation:
Header Elements
- Package name - Large, clickable link back to package overview
- Version selector - Dropdown to switch between available versions (when multiple exist)
- Version badge - Simple badge display for single-version packages
- Favorite heart - Click to save/remove from favorites
- Documentation link - Book icon for external documentation (when available)
- Package description - Brief explanation of package functionality
Interactive Features
- Package name click - Returns to package overview page
- Version dropdown - Navigate directly to other versions
- Favorites toggle - Heart icon changes when clicked
- External docs - Opens documentation in new tab/window
Tab Navigation System
The package version page uses a comprehensive tab system to organize information:
Available Tabs
- Overview - Documentation browser with README, vignettes, and package details
- Dependencies - Interactive dependency trees and requirement lists
- Reverse Dependencies - Packages that depend on this package
- Additional Info - Version history, authors, and archive information
Tab Behavior
- Single active tab - Only one tab content visible at a time
- Persistent state - Tab selection remembered during navigation via URL
Overview Tab
The Overview tab provides an integrated documentation browsing experience:
Documentation Sidebar
The sidebar provides navigation for all available documentation:
Documentation Viewer
The main content area displays documentation in an embedded viewer:
Viewer Features
- Embedded display - Documentation loads within PRISM interface
- Full functionality - All documentation features available
- Responsive layout - Adjusts to available screen space
- External links - Links to license, GitHub, issues, and website
Package Description
Below the header, key package information is displayed:
Description Handling
- Truncated display - Long descriptions automatically truncated
- Expand button - “Show more” button for longer descriptions
- Automatic detection - Expand button only appears when needed
- Responsive behavior - Adapts to screen size changes
Additional Details
- Release date - When the version was published
- External links - License, GitHub, issues, website access
- Link availability - Gray icons when links not available
Dependencies Tab
The Dependencies tab provides comprehensive dependency analysis:
Dependency Tables
Dependencies are organized into clear categories:
Table Categories
- R Version - Required R version constraints
- Depends, Imports, & Enhances - Core package dependencies
- LinkingTo - C/C++ linking dependencies
- Suggests - Optional or recommended packages
Dependency Information
- Package names - Clickable links to dependency packages
- Version constraints - Required version ranges
- Dependency types - Import, depends, suggests, etc.
- Recursive indicator - Shows indirect dependencies
Recursive Dependencies Toggle
Control the display of indirect dependencies (shown by default). Toggling the Recurisve dependencies off will only show direct dependencies for a particular package:
Showing the recursive dependencies by default gives the users a more complete picture of the package’s dependencies. This is especially useful for packages that have many dependencies, or for packages that are used in many other packages.
Toggle Functionality
- Direct dependencies - Always visible (required by this package)
- Indirect dependencies - Hidden by default, shown when toggled
- Visual distinction - Different styling for direct vs. indirect
- Stricter constraints - Shows most restrictive version requirements
Interactive Dependency Tree
An interactive network graph showing package relationships:
Tree Features
- Collapsible section - Click chevron to expand/collapse tree
- Interactive graph - Pan, zoom, and search within the visualization
- Node connections - Visual representation of package dependencies
- Search functionality - Find specific packages within the tree
Graph Controls
- Search box - Find packages by name
- Fit view button - Reset graph to optimal view
- Navigation instructions - Clear guidance for graph interaction
- Loading indicator - Shows while graph is being generated
Graph Interaction
- Pan - Click and drag to move around
- Zoom - Shift + scroll wheel to zoom in/out
- Node search - Highlight specific packages
- Reset view - Return to default view
Reverse Dependencies Tab
Shows packages that depend on the current package:
Table Content
- Package names - Clickable links to dependent packages
- Package titles - Brief descriptions of dependent packages
- Dependency type - How they depend on this package
- Version constraints - What versions they require
Table Features
- Sortable columns - Click headers to sort by any field
- Filterable content - Search within reverse dependencies
- Click navigation - Click package names to view details
- Comprehensive data - Shows all packages using this one
Additional Info Tab
Provides supplementary package information:
Version History
Displays all available versions of the package:
Version Cards
- Version numbers - Clear identification of each version
- Release dates - When each version was published
- Archived status - Visual indication of archived versions
- Click navigation - Click versions to view their details
Archive Indicators
- Archived overlay - Gray overlay for replaced versions
- Archive message - Explanation of archived status
- Edition availability - Shows where archived versions can be found
Author Information
Lists package authors and contributors:
User Interactions
Version Switching
Navigate between different package versions:
Dropdown Features
- Available versions - All versions with documentation indicators
- Current selection - Highlighted current version
- Direct navigation - Click to switch versions immediately
- Documentation status - Book icons show which versions have docs
Favorites Management
Save packages for quick access:
Heart Icon States
- Unfilled heart - Package not in favorites
- Filled red heart - Package saved as favorite
- Click toggle - Add/remove from favorites
- Persistent storage - Favorites saved in browser
External Documentation
Access full documentation outside PRISM:
Documentation Access
- Book icon - Opens external documentation
- New tab - Documentation opens separately
- Full features - Complete documentation functionality
- Version-specific - Links to correct version
Common Workflows
Exploring Package Documentation
- Start with Overview tab - Begin with README and basic information
- Browse vignettes - Use sidebar to explore tutorials and guides
- Check changelog - Review version history and updates
- Access external docs - Use book icon for complete documentation
Understanding Package Dependencies
- Review dependency tables - Start with main dependencies
- Toggle recursive view - Show/hide indirect dependencies
- Explore dependency tree - Use interactive visualization
- Check reverse dependencies - See what packages use this one
Comparing Package Versions
- Use version dropdown - Switch between available versions
- Compare changelogs - Review differences between versions
- Check dependency changes - See how requirements evolved
- Note archive status - Understand version availability
Planning Package Usage
- Check R version requirements - Ensure compatibility
- Review dependencies - Understand what else you’ll need
- Read documentation - Understand package functionality
- Save as favorite - Mark for future reference
Troubleshooting
Common Issues
Documentation not loading in iframe?
- Check your internet connection
- Try the external documentation link (book icon)
- Ensure JavaScript is enabled in your browser
- Try refreshing the page
Version dropdown not working?
- Ensure JavaScript is enabled
- Try refreshing the page if dropdown seems stuck
- Check that you’re clicking the dropdown area properly
Dependency tree not expanding?
- Click the chevron icon to expand the tree section
- Wait for the loading indicator to complete
- Try refreshing if the tree seems stuck loading
Can’t navigate between tabs?
- Ensure JavaScript is enabled in your browser
- Try clicking directly on tab names
- Refresh the page if tabs seem unresponsive