bigmemory.sri/0000755000176200001440000000000014547550045013051 5ustar liggesusersbigmemory.sri/NAMESPACE0000644000176200001440000000016614332550435014266 0ustar liggesusers# Generated by roxygen2: do not edit by hand export(attach.resource) export(describe) importFrom(methods,setGeneric) bigmemory.sri/man/0000755000176200001440000000000014547344635013632 5ustar liggesusersbigmemory.sri/man/attach.resource.Rd0000644000176200001440000000140514547543072017207 0ustar liggesusers% Generated by roxygen2: do not edit by hand % Please edit documentation in R/sri.R \name{attach.resource} \alias{attach.resource} \title{Create an Object that Makes Use of a Shared Resource} \usage{ attach.resource(obj, ...) } \arguments{ \item{obj}{a descriptor object describing the location and type of a shared resource.} \item{...}{other information needed for object-specific attaching.} } \value{ An R object that makes use of a share resource. } \description{ This generic function should be used to attach to a system-wide shared resource on a computer. It is used by other packages. } \examples{ # Create a concrete function. setMethod( "attach.resource", signature(obj = "NULL"), function (obj, ...) { NULL } ) # Describe it attach.resource(NULL) } bigmemory.sri/man/describe.Rd0000644000176200001440000000146514547543002015674 0ustar liggesusers% Generated by roxygen2: do not edit by hand % Please edit documentation in R/sri.R \name{describe} \alias{describe} \title{Create a Description of a Shared Resource} \usage{ describe(x) } \arguments{ \item{x}{the object to create the descriptor for.} } \value{ A user-defined description of a shared resource. } \description{ This generic function should be used for creating a description of a shared resource and is used in conjunction with \code{attach.resource()} to utilize shared resources from an R session. } \examples{ # Create a concrete function. setMethod( "describe", signature(x = "list"), function (x) { print(x$value) } ) # Create an object to describe. tst = list(loc = "in_ram_not_shared", value = "hello world") # Describe it describe(tst) } \seealso{ [bigmemory.sri::attach.resource()] } bigmemory.sri/DESCRIPTION0000644000176200001440000000144014547550045014556 0ustar liggesusersPackage: bigmemory.sri Type: Package Title: A Shared Resource Interface for Bigmemory Project Packages Version: 0.1.8 Authors@R: c( person(given = "Michael J.", family = "Kane", role = c("aut", "cre"), email = "bigmemoryauthors@gmail.com", comment = c(ORCID = "0000-0003-1899-6662")) ) Description: A shared resource interface for the bigmemory and synchronicity packages. Encoding: UTF-8 Language: en-US License: LGPL-3 | Apache License 2.0 Enhances: bigmemory Imports: methods RoxygenNote: 7.2.3 NeedsCompilation: no Packaged: 2024-01-10 16:31:18 UTC; mike Author: Michael J. Kane [aut, cre] () Maintainer: Michael J. Kane Repository: CRAN Date/Publication: 2024-01-10 17:13:09 UTC bigmemory.sri/R/0000755000176200001440000000000014547543104013250 5ustar liggesusersbigmemory.sri/R/sri.R0000644000176200001440000000310114547543104014163 0ustar liggesusers#' @title Create a Description of a Shared Resource #' #' @description This generic function should be used for creating a #' description of a shared resource and is used in conjunction with #' \code{attach.resource()} to utilize shared resources from an R session. #' @param x the object to create the descriptor for. #' @return A user-defined description of a shared resource. #' @seealso [bigmemory.sri::attach.resource()] #' @examples #' # Create a concrete function. #' setMethod( #' "describe", #' signature(x = "list"), #' function (x) { #' print(x$value) #' } #' ) #' #'# Create an object to describe. #'tst = list(loc = "in_ram_not_shared", value = "hello world") #' #'# Describe it #' describe(tst) #' @importFrom methods setGeneric #' @export setGeneric('describe', function(x) standardGeneric('describe')) #' @title Create an Object that Makes Use of a Shared Resource #' #' @description This generic function should be used to attach to a #' system-wide shared resource on a computer. It is used by other packages. #' @param obj a descriptor object describing the location and type of a #' shared resource. #' @param ... other information needed for object-specific attaching. #' @return An R object that makes use of a share resource. #' @examples #' # Create a concrete function. #' setMethod( #' "attach.resource", #' signature(obj = "NULL"), #' function (obj, ...) { #' NULL #' } #' ) #' #'# Describe it #' attach.resource(NULL) #' @importFrom methods setGeneric #' @export setGeneric('attach.resource', function(obj, ...) standardGeneric('attach.resource')) bigmemory.sri/MD50000644000176200001440000000035714547550045013366 0ustar liggesusers140224bccfe5ac66c4f9046b4534518e *DESCRIPTION 2b361b974542485b1406e7a4705057a8 *NAMESPACE 0de621d5f8f1552a567f262c493cfd64 *R/sri.R 1fdba54049b8d497f121cee89befcb2f *man/attach.resource.Rd c71b5155a702891de1adc18a6d23ee1e *man/describe.Rd