MIT License 116 | 117 | Copyright (c) 2018 Numeract 118 | 119 | Permission is hereby granted, free of charge, to any person obtaining a copy 120 | of this software and associated documentation files (the "Software"), to deal 121 | in the Software without restriction, including without limitation the rights 122 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 123 | copies of the Software, and to permit persons to whom the Software is 124 | furnished to do so, subject to the following conditions: 125 | 126 | The above copyright notice and this permission notice shall be included in all 127 | copies or substantial portions of the Software. 128 | 129 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 130 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 131 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 132 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 133 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 134 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 135 | SOFTWARE. 136 |137 | 138 |
All cache data will be stored only on the local disk.
123 | 124 |cache_file(cache_dir)127 | 128 |
| cache_dir | 133 |Directory where to store the cache files. |
134 |
|---|
A cache object that inherits from R6Cache.
Other cache functions: cache_memory_file,
144 | cache_memory, default_cache
# NOT RUN { 149 | cache_in_file <- cache_file("path_to_cache_diretory") 150 | # }152 |151 |
R/cache-functions.R
117 | cache_memory.RdAll cache data will be stored only in memory.
123 | 124 |cache_memory()
127 |
128 | A cache object that inherits from R6Cache.
Other cache functions: cache_file,
135 | cache_memory_file,
136 | default_cache
141 |cache_in_memory <- cache_memory()
R/cache-functions.R
118 | cache_memory_file.RdThe cache data will be stored both in memory (for quick access) and on 124 | disk (for persistence).
125 | 126 |cache_memory_file(cache_dir)129 | 130 |
| cache_dir | 135 |Directory where to store the cache files. |
136 |
|---|
A cache object that inherits from R6Cache.
Other cache functions: cache_file,
146 | cache_memory, default_cache
# NOT RUN { 151 | cache_fmem <- cache_memory_file("path_to_cache_diretory") 152 | # }155 |153 | 154 |
R6Flow or an Element object.R/flow-functions.R
117 | compute.R6Flow.RdTrigger computation for an R6Flow or an Element object.
# S3 method for R6Flow 127 | compute(x, ...) 128 | 129 | # S3 method for Element 130 | compute(x, ...)131 | 132 |
| x | 137 |A flow object, e.g. as returned by |
138 |
|---|---|
| ... | 141 |Any other arguments will be ignored. |
142 |
Logical, whether the result is available to be collected.
148 | 149 |Unlike collect, it does not trigger an error if it fails
152 | to compute and it does not return the actual result of the computation.
Currently, the default cache engine is cache_memory(), but this
124 | might change in the future.
default_cache()
129 |
130 | A cache object that inherits from R6Cache.
Other cache functions: cache_file,
137 | cache_memory_file,
138 | cache_memory
# NOT RUN { 143 | current_cache <- default_cache() 144 | # }146 |145 |
R/eddy-functions.R
117 | default_eddy_env.RdGet the default binding environment that keeps the eddies.
123 | 124 |default_eddy_env()
127 |
128 | An environment.
131 | 132 | 133 |Imports from other packages
123 | 124 |R/flow-functions.R
119 | is_current.RdIf there is no current state, e.g. right after make_flow_fn,
125 | the flow is "not flowing", it is preventing downstream flows
126 | from being computed.
is_current(flow)131 | 132 |
| flow | 137 |A flow object, e.g. as returned by |
138 |
|---|
A logical value, whether the current state is valid.
144 | 145 | 146 |149 |#>is_current_flow <- is_current(flowed_fn)
R/flow-functions.R
117 | is_flow.RdIs the object a flow object or a flow element?
123 | 124 |is_flow(x)127 | 128 |
| x | 133 |An object. |
134 |
|---|
A logical value, whether x is a flow object.
145 |#>is_input_flow <- is_flow(flow_function)
make_flow_fn)?R/flow-functions.R
117 | is_flow_fn.RdIs the function a flow function (as returned by make_flow_fn)?
is_flow_fn(fn)127 | 128 |
| fn | 133 |A function. |
134 |
|---|
A logical value, whether fn is a flow function.
145 |#>is_flow_function <- is_flow_fn(fn = flowed_function)
make_flow_fn).R/flow-functions.R
121 | is_not_flow_fn.RdCheck if the function is NOT a flow function
127 | (as returned by make_flow_fn).
is_not_flow_fn(fn)132 | 133 |
| fn | 138 |A function. |
139 |
|---|
A logical value, whether fn is a not flow function.
R/flow-functions.R
117 | is_valid.RdIs the current state valid (stored in the cache)?
123 | 124 |is_valid(flow, state = "current")127 | 128 |
| flow | 133 |A flow object, e.g. as returned by |
134 |
|---|---|
| state | 137 |A flow state. It can be either a valid state
138 | |
140 |
A logical value, whether the value can be obtained without 146 | triggering computation.
147 | 148 | 149 |152 |#>is_valid_flow <- is_valid(flowed_fn)
Assigns a value to a variable in a name space.
123 | 124 |to_ns(x, var_name, ns)127 | 128 |
| x | 133 |Value to assign. |
134 |
|---|---|
| var_name | 137 |The name (as string) of the variable. |
138 |
| ns | 141 |The name space, either an |
143 |
The initial value, x