WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

ResourceFunction   
✖
ResourceFunction

Wolfram Function Repository »
[Experimental]

✖
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 $ResourceSystemPathwhere to look for a function
    ResourceVersion Automaticversion 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 allclose all

Basic Examples  (5)Summary of the most common use cases

Get a resource function using its name:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-bicmr5
Out[1]=1

Apply the resource function to arguments:

In[2]:=2
✖
https://wolfram.com/xid/0dqwfzhcu4i-ltcgqs
Out[2]=2

Apply a function from a ResourceObject to a value:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-qxlji
Out[1]=1

Find properties of a resource function:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-ep94l
Out[1]=1

Get the web documentation URL for a published function:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-j42pda
Out[1]=1

Create a resource function from an Association:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-fyv0pp
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0dqwfzhcu4i-etxpkx
Out[2]=2

Scope  (7)Survey of the scope of standard use cases

Use the two-argument from of ResourceFunction to retrieve properties:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-1zo4k2
Out[1]=1

Get a list of properties:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-dftlk
Out[1]=1

Obtain information on a resource function:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-msl7ti
Out[1]=1

View basic usage:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-ftefpd
Out[1]=1

Run all verification tests defined for a resource function to generate a TestReportObject:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-1i0h7
Out[1]=1

A Missing object is returned for resource functions that do not have defined tests:

In[2]:=2
✖
https://wolfram.com/xid/0dqwfzhcu4i-burgkl
Out[2]=2

See all the tests defined for a resource function in a testing notebook:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-cps6a7
Out[1]=1

See when a resource function was first published to the Wolfram Function Repository:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-frqqd9
Out[1]=1

Get the date of the most recent update:

In[2]:=2
✖
https://wolfram.com/xid/0dqwfzhcu4i-br5jbs
Out[2]=2

Get a list of available versions:

In[3]:=3
✖
https://wolfram.com/xid/0dqwfzhcu4i-cpzgvv
Out[3]=3

Options  (3)Common values & functionality for each option

ResourceSystemPath  (2)

Use ResourceSystemPath to limit the result to only find functions published in the function repository:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-qmgtm3
Out[1]=1

Create a new resource function with the same name as a deployed function:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-dp2k87
Out[1]=1

Use ResourceSystemPath to ensure this resource is found:

In[2]:=2
✖
https://wolfram.com/xid/0dqwfzhcu4i-bipby9
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0dqwfzhcu4i-uaw9x5
Out[3]=3

Instead, find the published function:

In[4]:=4
✖
https://wolfram.com/xid/0dqwfzhcu4i-jskq2u
Out[4]=4
In[5]:=5
✖
https://wolfram.com/xid/0dqwfzhcu4i-zf60tv
Out[5]=5

ResourceVersion  (1)

Get two versions of the same resource from the function repository using ResourceVersion:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-4lt3vw
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0dqwfzhcu4i-sl31yl
Out[2]=2

Only the newer version supports a zero-argument form:

In[3]:=3
✖
https://wolfram.com/xid/0dqwfzhcu4i-cal24v
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0dqwfzhcu4i-ccuk8n
Out[4]=4

Properties & Relations  (3)Properties of the function, and connections to other functions

The two-argument form of ResourceFunction provides the same values as ResourceObject:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-bop9y7
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0dqwfzhcu4i-erdmqw
Out[2]=2

The underlying symbol belonging to a ResourceFunction can be obtained using the "Function" property:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-czbzg
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0dqwfzhcu4i-bpybdt

Using the symbol directly can often be faster:

In[3]:=3
✖
https://wolfram.com/xid/0dqwfzhcu4i-g10p2h
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0dqwfzhcu4i-ey67u
Out[4]=4

Many functions that work on symbols also work on resource functions, for example, DownValues:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-p8j8nf
Out[1]=1

And Attributes:

In[2]:=2
✖
https://wolfram.com/xid/0dqwfzhcu4i-ormml2
Out[2]=2

And Options:

In[3]:=3
✖
https://wolfram.com/xid/0dqwfzhcu4i-2wiu1i
Out[3]=3

Possible Issues  (1)Common pitfalls and unexpected behavior

Resource functions that have holding attributes will only hold arguments if ResourceFunction[…] is explicitly used as the head:

In[1]:=1
✖
https://wolfram.com/xid/0dqwfzhcu4i-bg0yk
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0dqwfzhcu4i-j8gt4h
Out[2]=2

Use ResourceFunction[…][…] instead to ensure attributes will work:

In[3]:=3
✖
https://wolfram.com/xid/0dqwfzhcu4i-ejknmu
Out[3]=3

Using the formatted form will also work:

In[4]:=4
✖
https://wolfram.com/xid/0dqwfzhcu4i-c3521q
Out[4]=4

Alternatively, set the symbol to the underlying function instead:

In[5]:=5
✖
https://wolfram.com/xid/0dqwfzhcu4i-gmctkn
Out[5]=5
In[6]:=6
✖
https://wolfram.com/xid/0dqwfzhcu4i-rnpmjd
Out[6]=6
Wolfram Research (2019), ResourceFunction, Wolfram Language function, https://reference.wolfram.com/language/ref/ResourceFunction.html.
✖
Wolfram Research (2019), ResourceFunction, Wolfram Language function, https://reference.wolfram.com/language/ref/ResourceFunction.html.

Text

Wolfram Research (2019), ResourceFunction, Wolfram Language function, https://reference.wolfram.com/language/ref/ResourceFunction.html.

✖
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.

✖
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

✖
Wolfram Language. (2019). ResourceFunction. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/ResourceFunction.html

BibTeX

@misc{reference.wolfram_2025_resourcefunction, author="Wolfram Research", title="{ResourceFunction}", year="2019", howpublished="\url{https://reference.wolfram.com/language/ref/ResourceFunction.html}", note=[Accessed: 03-June-2025 ]}

✖
@misc{reference.wolfram_2025_resourcefunction, author="Wolfram Research", title="{ResourceFunction}", year="2019", howpublished="\url{https://reference.wolfram.com/language/ref/ResourceFunction.html}", note=[Accessed: 03-June-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_resourcefunction, organization={Wolfram Research}, title={ResourceFunction}, year={2019}, url={https://reference.wolfram.com/language/ref/ResourceFunction.html}, note=[Accessed: 03-June-2025 ]}

✖
@online{reference.wolfram_2025_resourcefunction, organization={Wolfram Research}, title={ResourceFunction}, year={2019}, url={https://reference.wolfram.com/language/ref/ResourceFunction.html}, note=[Accessed: 03-June-2025 ]}