PRISM Documentation: Package Overview Page

Back to Help

Getting Started

PRISM Package Overview Page

The Package Overview page displays all available versions of a specific R package. This page serves as a central hub for exploring different versions of a package, accessing documentation, and understanding version history.

Quick Actions:

  1. 📖 View package details - Click version numbers to see detailed package information
  2. 📚 Access documentation - Click “Docs” links for package documentation
  3. 🔗 Navigate versions - Easily switch between different package versions

Getting to Package Overview Pages

Page Structure

Package Header

PRISM Package Overview Page, header

The header provides general package identification:

Header Elements

  • Package name - Large, prominent package identifier (e.g., “ghqc”)
  • Package description - Brief explanation of package functionality

Version Grid

PRISM Package Overview Page, versions grid

The main content area displays all available package versions as cards:

Version Cards

Each version appears as an individual card containing:

  • Version number - Prominently displayed (e.g., “0.3.3”, “0.4.2”)
  • Documentation link - “Docs” button when documentation is available
  • Click navigation - Entire card area clickable for version details

User Interactions

Version cards provide two separate interaction methods:

Click To Version Page

PRISM Package Overview Page, version click

Navigate to detailed version page (see package version help page)

Click To Docs

PRISM Package Overview Page, docs click
  • Direct links - Click “Docs” to open documentation in new tab/window

Documentation Availability

  • Version-specific - Each version may have different documentation
  • External navigation - Documentation opens separately from main PRISM interface

Not all versions have documentation

PRISM Package Docs Request Page

If there are versions without documentation, users will be led to a error page. If users wish to have documentation generated for a version, clicking the “Request Docs” button will send us a request to generate that documentation, and we may update our content in the future accordingly.

PRISM Package Docs Request Thank You Page

Registry Filtering Impact

Filter Behavior

PRISM Package Overview Page Filtered

The registry filter (in top navigation) affects which versions appear:

Filtering Effects

  • Version visibility - Only versions from selected registries appear
  • Automatic updates - Changes happen immediately when filter changes
  • Warning messages - Yellow alerts when some versions are filtered out
  • No versions scenario - Message appears if no versions match filters

Filter Interaction

  • Site-wide setting - Registry filter affects all PRISM pages

Common Workflows

Exploring Package Versions

  1. Arrive at overview - Navigate to package via search or listing
  2. Review available versions - Scan version cards to see what’s available
  3. Check documentation - Look for “Docs” links on versions of interest
  4. Select version - Click version card to see detailed information
  5. Access documentation - Use “Docs” links for package help

Working with Package Documentation

  1. Identify documented versions - Look for “Docs” links
  2. Access documentation - Click to open in new tab
  3. Review package help - Study documentation for usage guidance
  4. Return to overview - Come back to explore other versions
  5. Cross-reference versions - Compare documentation across versions

Troubleshooting

Common Issues

No versions showing?

  • Check your registry filter settings in the top navigation
  • Verify the package name is spelled correctly in the URL
  • Try setting registry filter to “All Registries”

Missing documentation links?

  • Documentation availability varies by package and version
  • Not all versions have generated documentation
  • Try different versions to find documented ones

Can’t navigate to version details?

  • Ensure JavaScript is enabled in your browser
  • Try refreshing the page if clicks aren’t responding
  • Check that you’re clicking the version number area

Page not loading properly?

  • Verify the package name exists in PRISM
  • Check your internet connection
  • Try accessing the package through search instead of direct URL