the_Namespaces: A function that returns information about the loaded...

Description Usage Arguments Value

View source: R/the_Namespaces.R

Description

This function inspects the loaded namespaces, and returns information in accordance with the user-defined specifications.

Usage

1
2
the_Namespaces(.ns, .details = TRUE, .pattern, .type = c("all",
  "exported", "internal"))

Arguments

.ns

An optional argument that can be used if it's of interest to inspect a particular namespace. The default is that all the loaded namespaces are investigated.

.details

A logical value that specifies the amount of information to return, default value TRUE.

.pattern

An optional regular expression. Only names matching .pattern are returned. glob2rx can be used to convert wildcard patterns to regular expressions.

.type

One of the values c("all", "exported", "internal"), the default being "all", which can be used to restrict the returned details with regard to show only exported or internal objects.

Value

If .details is FALSE, the result will simply be the names of the loaded namespaces (in essence the same result as obtained when using sort upon the result from loadedNamespaces). If the .ns-argument has been supplied, then only the namespace specified there will be treated. Different attributes will be added to the result when .details is given as TRUE. One of the attributes will be .pattern (which mainly is included in order for the print-method to figure out what to write), and then there will in addition be one attribute corresponding to each namespace (having the same names), and each of these attributes will be a list containing the following components.

content

A vector, that describes the content of the namespace; it's the result of ls used upon the namespace, with restrictions based on .pattern. No restrictions will be used if .pattern is left unspecified.

exported

A logical vector that for each part of content tells if the object was exported or not.

is

A list that gives the result of is when it is used upon the different components.


LAJordanger/leanRcoding documentation built on Feb. 27, 2020, 4:42 p.m.