Macaulay2 » Documentation
Packages » Macaulay2Doc » The Macaulay2 language » packages » Package
next | previous | forward | backward | up | index | toc

Package -- the class of all packages

Description

See packages for an overview about using and writing Macaulay2 packages.

Available packages:

Functions useful when using packages:

  • needsPackage -- load a package if not already loaded
  • loadPackage -- load a package
  • installPackage -- load and install a package and its documentation
  • check -- perform tests of a package
  • debug -- assistant for debugging packages, dictionaries, etc
  • importFrom -- import symbols to the current private dictionary

Functions useful when creating a package:

Functions useful when debugging a package:

  • debugging
  • debug -- assistant for debugging packages, dictionaries, etc
  • check -- perform tests of a package

Functions that are only rarely used:

See also

Functions and methods returning a package:

Methods that use a package:

  • ? Package -- see ? Symbol -- view brief documentation of a symbol
  • check(List,Package) -- see check -- perform tests of a package
  • check(Package) -- see check -- perform tests of a package
  • check(ZZ,Package) -- see check -- perform tests of a package
  • debug(Package) -- open the private dictionary of a package
  • dismiss(Package) -- see dismiss -- dismiss a package
  • exportFrom(Package,List) -- see exportFrom -- export symbols from a package's private dictionary
  • exportFrom(Package,String) -- see exportFrom -- export symbols from a package's private dictionary
  • importFrom(Package,List) -- see importFrom -- import symbols to the current private dictionary
  • importFrom(Package,String) -- see importFrom -- import symbols to the current private dictionary
  • installPackage(Package) -- see installPackage -- load and install a package and its documentation
  • loadPackage(Package) -- see loadPackage -- load a package
  • locate(Package) -- see locate -- locate source code
  • methods(Package) -- see methods -- list methods
  • options(Package)
  • package(Package) -- see package -- get containing package
  • readPackage(Package) -- see readPackage -- read the package preamble
  • tests(Package) -- see tests -- locate a package's tests
  • tests(ZZ,Package) -- see tests -- locate a package's tests
  • uninstallPackage(Package) -- see uninstallPackage -- uninstall a package and remove its documentation
  • use(Package) -- activate a previously dismissed package

Protected objects of class Package:

  • Core -- the core of Macaulay2
  • User -- default package for interpreter interactions

For the programmer

The object Package is a type, with ancestor classes MutableHashTable < HashTable < Thing.

The source of this document is in /build/reproducible-path/macaulay2-1.26.06+ds/M2/Macaulay2/packages/Macaulay2Doc/functions/package-doc.m2:689:0.