ResourceFunction
Wolfram Function Repository »ResourceFunction[resource]
represents the function associated with the specified resource.
ResourceFunction[resource,prop]
gives the specified property of the resource.
Details and Options
- ResourceFunction["name"] searches in order for a resource function with the specified name in the following locations:
-
locally in the session (for resource functions from DefineResourceFunction) at the locations specified by $PersistencePath in the Wolfram Function Repository - In ResourceFunction[resource], resource can have the following forms:
-
"name" function name, resolved as described ResourceObject[…] a resource object of type "Function" stored at any location CloudObject[…] a cloud object containing a function resource object LocalObject[…] a local object containing a function resource object - ResourceFunction[resource][args …] applies the function to the given arguments.
- The available properties are given by ResourceFunction[resource,"Properties"] and typically include properties of the ResourceObject as well as:
-
"SymbolName" fully qualified string name of the underlying function "FunctionLocation" file, object or method used to store the definition "DocumentationLink" URL for documentation of a published function - ResourceFunction accepts the following options:
-
ResourceSystemPath $ResourceSystemPath where to look for a function ResourceVersion Automatic version to select of a published resource - Function definitions in a function resource are typically not explicitly retrieved until the function is used.
- When the definitions for a function resource are retrieved, they are usually cached in $LocalBase.
- ResourceObject[ResourceFunction[…]] returns the resource object containing the given function.
- ResourceFunction[ResourceFunction[…],prop] gives a property for an existing resource function.
- CloudDeploy[ResourceFunction[…]] or CloudPublish[ResourceFunction[…]] saves a resource function in the cloud.
- LocalCache[ResourceFunction[…]] saves a resource function as a LocalObject[…].
- The following functions work on ResourceFunction objects: Attributes, Definition, DownValues, FullDefinition, Options and SymbolName.
- New resource functions can be defined with DefineResourceFunction or with a definition notebook from File ▶ New ▶ Repository Item ▶ Function Repository Item.
Examples
open all close allBasic Examples (5)
Get a resource function using its name:
ResourceFunction["NestedLookup"]Apply the resource function to arguments:
ResourceFunction["NestedLookup"][<|"Flintstones" -> <|"Fred" -> <|"Job" -> "Bronto crane Operator"|>, "Wilma" -> <|"Job" -> "Cavemaker"|>, "Pebbles" -> <|"Job" -> "Child"|>|>|>, {"Flintstones", "Fred", "Job"}]Apply a function from a ResourceObject to a value:
ResourceFunction[ResourceObject[Association["Name" -> "GrayCode", "UUID" -> "392603a7-1e9d-46d3-8532-bf09565c732a",
"ResourceType" -> "Function", "Version" -> "1.0.0",
"Description" -> "Find the Gray code for an integer", "RepositoryLocation" ->
URL["http ... nctionRepository`$f2402e26e61b4c54b73496fc57b6504d`GrayCode",
"FunctionLocation" -> CloudObject[
"https://www.wolframcloud.com/objects/0050708c-82d0-490c-b9a9-2c5e6b23a00b"],
"ShortName" -> "GrayCode"], {ResourceSystemBase -> Automatic}]][100]Find properties of a resource function:
ResourceFunction["MoveMouse", "Description"]Get the web documentation URL for a published function:
ResourceFunction["MultiNonlinearModelFit", "DocumentationLink"]Create a resource function from an Association:
rf = ResourceFunction[<|"Name" -> "Half Squared", "Function" -> ((# / 2) ^ 2&), "ResourceType" -> "Function"|>]rf[20]Scope (7)
Use the two-argument from of ResourceFunction to retrieve properties:
ResourceFunction["PerpendicularSurface", "Description"]ResourceFunction["BirdSay", "Properties"]Obtain information on a resource function:
Information[ResourceFunction["BirdSay"]]ResourceFunction["BirdSay", "Usage"]Run all verification tests defined for a resource function to generate a TestReportObject:
ResourceFunction["UUIDQ", "TestReport"]A Missing object is returned for resource functions that do not have defined tests:
ResourceFunction["BirdSay", "TestReport"]See all the tests defined for a resource function in a testing notebook:
ResourceFunction["UUIDQ", "TestNotebook"]See when a resource function was first published to the Wolfram Function Repository:
ResourceFunction["GrayCode", "ReleaseDate"]Get the date of the most recent update:
ResourceFunction["GrayCode", "LatestUpdate"]Get a list of available versions:
ResourceFunction["GrayCode", "VersionsAvailable"]Options (3)
ResourceSystemPath (2)
Use ResourceSystemPath to limit the result to only find functions published in the function repository:
ResourceFunction["InspectNotebook", ResourceSystemPath -> {URL["https://resources.wolframcloud.com"]}]Create a new resource function with the same name as a deployed function:
DefineResourceFunction["A bird said: " <> #&, "BirdSay"]Use ResourceSystemPath to ensure this resource is found:
myrf = ResourceFunction["BirdSay", ResourceSystemPath -> {PersistenceLocation["KernelSession"]}]myrf["Chirp"]Instead, find the published function:
publicrf = ResourceFunction["BirdSay", ResourceSystemPath -> {URL["https://resources.wolframcloud.com"]}]publicrf["Tweet"]ResourceVersion (1)
Get two versions of the same resource from the function repository using ResourceVersion:
new = ResourceFunction["EasterSunday", ResourceVersion -> "3.0.0"]old = ResourceFunction["EasterSunday", ResourceVersion -> "2.0.0"]Only the newer version supports a zero-argument form:
new[]old[]Properties & Relations (3)
The two-argument form of ResourceFunction provides the same values as ResourceObject:
ResourceFunction["GrayCode", "Description"]ResourceObject["GrayCode"]["Description"]The underlying symbol belonging to a ResourceFunction can be obtained using the "Function" property:
grayCode = ResourceFunction["GrayCode", "Function"]grayCode//InputFormUsing the symbol directly can often be faster:
RepeatedTiming[grayCode[25]]RepeatedTiming[ResourceFunction["GrayCode"][25]]Many functions that work on symbols also work on resource functions, for example, DownValues:
DownValues[ResourceFunction["RankedTimeSeriesBarChart"]]And Attributes:
Attributes[ResourceFunction["TraceInteractive"]]And Options:
Options[ResourceFunction["MonitoredDownload"]]Possible Issues (1)
Resource functions that have holding attributes will only hold arguments if ResourceFunction[…] is explicitly used as the head:
SetAttributes[myHold, HoldFirst];
rf = DefineResourceFunction[myHold]rf[1 + 1]Use ResourceFunction[…][…] instead to ensure attributes will work:
ResourceFunction["myHold"][1 + 1]Using the formatted form will also work:
ResourceFunction["myHold"][1 + 1]Alternatively, set the symbol to the underlying function instead:
func = ResourceFunction["myHold", "Function"]func[1 + 1]Related Links
Wolfram Data RepositoryText
Wolfram Research (2019), ResourceFunction, Wolfram Language function, https://reference.wolfram.com/language/ref/ResourceFunction.html.
CMS
Wolfram Language. 2019. "ResourceFunction." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/ResourceFunction.html.
APA
Wolfram Language. (2019). ResourceFunction. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/ResourceFunction.html