Package index • improveR

Authentication and Connection

improveConnect(): improveConnect
improveConnected(): improveConnected
improveDisconnect(): improveDisconnect
improveClose(): improveClose
improveEditable(): Verify Write Mode is Enabled (Guard Function)
improveOAuth(): Improve OAuth
improveInit(): Initialize R Modules from improve Repository
setEditable(): Enable or Disable Repository Write Mode
clearConnectionData(): Clear Connection Data
checkConnect(): checkConnect
getRepositoryVersion(): Get Repository Version

Resource Operations

loadResource(): Load Resource
loadResourceFromServer(): Load Resource From Server
loadResourceVersionFromServer(): Load Resource Version From Server
refreshResource() updateResource(): Refresh Resource
unloadResource(): Unload Resource
loadChildResources(): Load Child Resources
refreshChildResources() updateChildResources(): Refresh Child Resources from Server
unloadChildResources(): Unload Child Resources from Cache
loadFullChildResources(): loads all child resources by the resourceId, entity ID or entity version ID the childResources REST call does not return all the fields, like run status for steps, just the fields all resources have in common, with this function, the full resources are loaded It Uses Caching the results are returned as a data frame or a list of data frames the dates are also converted to posix dates via convertImproveTimestampToPosix resourceId can be a list
refreshFullChildResources() updateFullChildResources(): refreshFullChildResources
unloadFullChildResources(): unloadFullChildResources
createFile(): Create File in improve Repository
createFolder(): Create Folder in improve Repository
createLink(): Create Link to Resource
createExternalLink(): Create External Link in improve Repository
updateFileContent(): Update File Content Prerequisite: must be a file. Multiple files can be updated at once.
uploadFolder(): Upload a Complete Folder Prerequisite: must be a folder.
copy(): Copy Resources to Target Location
move(): Move Resources to Target Location
delete(): Delete Resources Permanently
getCopy(): Get a Local Copy of a File
getFile(): Get a File Object
getFilesFromFolder(): Retrieve a List of Files from a Folder
loadFile(): Load File
refreshFile() updateFile(): refreshFile
unloadFile(): unloadFile
isFileUp2Date(): isFileUp2Date
isResourceUp2Date(): Is Resource Up2 Date
updateLinks(): Update Link Resources to Latest Target Version
getParent(): Returns the Parent of Anything Resolved by GetCorrectId

Step and Workflow Management

attachStep(): Attach a Step to a Parent Step
detachStep(): Detach Step from Parent
changeStepDescription(): Change Step Description
changeStepRationale(): Change Step Rationale
getStep(): Get Step Environment
getStepTemplate(): Create Step Template
createStepEnv(): Create Step Environment
createStepTemplateEnv(): Create a Step Template Environment
createAnalysisTree(): Create Analysis Tree in improve Repository
createWorkflow(): Create New Workflow Environment
createWorkflowTemplateEnv(): Create a workflow template environment from an existing workflow
getWorkflow(): Load Workflow Environment
workflowTemplateFromJSON(): Load workflow template from JSON file
createWorkflowTemplateForImport(): Create a workflow template environment specifically for import operations
getMainProcess(): Get Main Process for a Step
getProcessFileVariables(): Get Process File Variables
setCommandFile(): Set Command File on a Realised Step
markStep(): Mark Step Flags
updateProcessProperty(): Update a Single Process Property on a Live Step
runStepResource(): Run a Step Resource
finishRunResource(): Wait for Step Execution to Finish
terminateStepResource(): Terminate a Running Step Resource
loadParentStep(): Loads the Parent Step of One Step, Not Applicable to Multiple Steps
refreshParentStep() updateParentStep(): Refresh Parent Step from Server
unloadParentStep(): Unload Parent Step
loadChildSteps(): Load Child Steps
refreshChildSteps() updateChildSteps(): Refresh Child Steps from Server
unloadChildSteps(): Unload Child Steps from Cache
loadParentalDescendant(): Load the parental/descendant relationships of a resource
refreshParentalDescendant() updateParentalDescendant(): Refresh parental/descendant cache for a resource
unloadParentalDescendant(): Unload parental/descendant cache for a resource

Tool and Runserver Management

loadToolCategories(): Load Tool Categories
loadToolsForCategory(): Load Tools for a Category
createToolCategory(): Create a Tool Category
renameToolCategory(): Rename a Tool Category
deleteToolCategory(): Delete a Tool Category
createTool(): Create a Tool in a Category
createToolInstance(): Create a Tool Instance on a Runserver
updateToolInstance(): Update a Tool Instance
createToolParameter(): Create a Tool Parameter on an Instance
updateToolParameter(): Update a Tool Parameter Value
getToolInstances(): Get Tool Instances
resetToolInstances(): Reset Tool Instance Cache
loadRunserver(): Loads Runserver By Label

Import and Export

exportFolder(): Export a Folder Hierarchy to a Portable Zip File
importFolder(): Import a Folder Hierarchy from a Zip File into a Repository Folder
exportWorkflow(): Export a Workflow to a Portable Zip File
importWorkflow(): Import a Workflow from a zip File into a Repository Folder

Permissions and Access Control

getResourcePermissions(): Get Resource ACL Entries
effectiveUserPermissions(): Get Effective Permissions for All Users
effectiveRights(): Get Effective User Rights for Resource
setResourcePermission(): Set a Permission on a Resource
replaceResourcePermissions(): Replace All Permissions on a Resource (Bulk PUT)
updateResourcePermission(): Update an Existing Permission on a Resource
removeResourcePermission(): Remove a Permission from a Resource
loadGroups(): List All Groups
loadGroup(): Get Group Details
loadGroupUsers(): Get Group Members
createGroup(): Create a Group
deleteGroup(): Delete a Group
addGroupUser(): Add a User to a Group
removeGroupUser(): Remove a User from a Group
addSubgroup(): Add a Subgroup to a Group
users(): List All Users in improve Repository
whoami(): Get Current Authenticated User

Favorites

loadFavorites(): Load Favorites
loadFavoriteChildren(): Load Favorite Children
addFavoriteLink(): Add Favorite Link
createFavoriteFolder(): Create Favorite Folder
removeFavorite(): Remove Favorite

Reviews

createReview(): Creates a New Review
getReviewById(): Get Review By ID
acceptReviewInvitation(): Accept Review Invitation
declineReviewInvitation(): Decline Review Invitation
changeReviewStatus(): Change Review Status
loadReviews(): Loads All Registered Reviews
refreshReviews() updateReviews(): Reloads the Reviews
unloadReviews(): Unloads All Reviews
createReviewer(): Adds a User as Reviewer to a Review
deleteReviewer(): Removes a Reviewer from a Review
getReviewers(): Get Reviewers
loadReviewers(): Loads All The Reviewers For A Review
refreshReviewers() updateReviewers(): Reloads the Reviewers for a Review
unloadReviewers(): Unloads the Reviewers for a Review
approveReviewEntries(): Approve Review Entries
rejectReviewEntries(): Reject Review Entries
resetReviewEntries(): Reset Review Entry Approval State
createReviewEntry(): Add Review Entries
deleteReviewEntry(): Delete Review Entries
getReviewEntries(): Get Review Entries
loadReviewEntries(): Loads All The Review Entries For A Review
refreshReviewEntries() updateReviewEntries(): Reloads the Review Entries for a Review
unloadReviewEntries(): Unloads the Review Entries for a Review
createReviewComment(): Creates a Comment for a Review
createReviewEntryComment(): Creates a Comment for a Review Entry
getReviewComments(): Get Review Comments
getReviewEntryComments(): Get Review Entry Comments
loadReviewComments(): Loads All The Review Comments For A Review
refreshReviewComments() updateReviewComments(): Reloads the Review Comments for a Review
unloadReviewComments(): Unloads the Review Comments for a Review

Metadata and Resource Relations

addMetaDate(): Adds Metadata Value To A Resource, Always Adds, Never Updates
addBulkMetaDate(): Adds Metadata Value To A Resource, Always Adds, Never Updates
updateMetaDate(): Updates Metadata Value To A Resource
updateMetaDateById(): Updates Metadata Value To A Resource
deleteMetaDate(): Deletes Metadata From A Resource
getMetaData(): Gets a Metadata Data Frame
getMetaDataMap(): Loads the Metadata of a Given Resource and Writes It as String Values Into a List
loadMetaData(): Loads the History by the ResourceId, Entity ID or Entity Version ID it uses caching the results are returned as a data frame or a list of data frames the dates are also converted to posix dates via convertImproveTimestampToPosix resourceId can be a list
refreshMetaData() updateMetaData(): Refresh Meta Data
unloadMetaData(): Unload Meta Data
loadMetaDataDefinition(): Loads One Meta Data Definitions By Name For A Scope, The Default Scope Is "Improve Client"
loadMetaDataDefinitionPickList(): Loads One Meta Data Definition Picklist Values By Name For A Scope, The Default Scope Is "Improve Client"
loadMetaDataDefinitions(): Loads All Meta Data Definitions For A Scope, The Default Scope Is "Improve Client"
refreshMetaDataDefinitions() updateMetaDataDefinitions(): Refresh Meta Data Definitions
unloadMetaDataDefinitions(): Unload Meta Data Definitions
createResourceRelation(): Creates a New Resource Relation
updateResourceRelation(): Updates a Resource Relation
deleteResourceRelation(): Deletes a Resource Relation
loadResourceRelations(): Loads All Registered Resource Relations
refreshResourceRelations() updateResourceRelations(): Reloads the Resource Relations
unloadResourceRelations(): Unloads All Resource Relations
createRelationType(): Create a New Relation Type
updateRelationType(): Update an Existing Relation Type
deleteRelationType(): Delete a Relation Type
loadRelationTypes(): Loads All Registered Relation Types
refreshRelationTypes() updateRelationTypes(): Reloads the Relation Types
unloadRelationTypes(): Unloads All Relation Types

Resource Lifecycle

finishResource(): Finish Resource
reopenResource(): Reopen Resource
lockResource(): Lock Resource for Exclusive Editing
unlockResource(): Unlock Resource to Allow Collaborative Access

Transactions

getLatestRevision(): Get Latest Revision
getLatestRun(): Get Latest Run
getRun(): Get Run
getRunGridArguments(): Get Run Grid Arguments
getRunParameters(): Get Run Parameters
getRunPhases(): Get Run Phases
createTransaction(): Create Transaction

History and Audit Trail

loadHistory(): Loads the History by the ResourceId, Entity ID or Entity Version ID it uses caching the results are returned as a data frame or a list of data frames the dates are also converted to posix dates via convertImproveTimestampToPosix resourceId can be a list
refreshHistory() updateHistory(): refreshHistory
unloadHistory(): unloadHistory
loadAuditTrail(): Load Audit Trail
refreshAuditTrail() updateAuditTrail(): Refresh Audit Trail from Server
unloadAuditTrail(): Unload Audit Trail from Cache
getFullFolderAuditTrail(): Retrieve Recursive Audit Trail For A Specific Folder
loadReferences(): Loads the References by the ResourceId, Entity ID or Entity Version ID it uses caching the results are returned as a data frame or a list of data frames the dates are also converted to posix dates via convertImproveTimestampToPosix resourceId can be a list
refreshReferences() updateReferences(): Refresh References
unloadReferences(): Unload References

CLI Tools

cloneCli(): Clone CLI Resource
pullCli(): Pull CLI
pushCli(): Push CLI
pushRunCli(): Push Run CLI
versionCli(): Version CLI
createContentCache(): Create Content Cache

Token Management

refreshToken(): Refresh token using registered refresher
applyTokenData(): Apply token data to session
updateAccessToken(): Update access token in current session
getCurrentTokenData(): Get current token data
shouldRefreshToken(): Check if token should be refreshed
getActiveTokenRefresher(): Get active token refresher
getTokenRefresher(): Get registered token refresher
listTokenRefreshers(): List registered token refreshers
registerTokenRefresher(): Register a token refresher plugin

Data Retrieval Helpers

getData(): Get Data Table from improve Repository
getGraphics(): Get Graphics File from improve Repository
getHTML(): Get HTML File from improve Repository
getR(): Get R Script or RDS Object from improve Repository
getTextString(): Get Text File as Character String
includeGraphics(): Include Graphics in Knitr Chunk
showGraphics(): Generate Markdown Syntax for Graphics
showHTML(): Includes HTML in rMarkdown, creates a string that has to be outputted
sourceR(): Source R Scripts from improve Repository

Query and Search

query(): Search Resources Using Elasticsearch Query
queryFolder(): Search Resources Within a Folder Using Elasticsearch Query

SSH Tunnels

improveSetupSSH(): Set Up SSH Keys for Tunnel Access
improveOpenTunnel(): Open SSH Tunnel to a Running Step
improveCloseTunnel(): Close an SSH Tunnel

Utilities

getCorrectId(): getCorrectId
normalisePath(): normalisePath
repoPrefix(): Get the Repository Entity ID Prefix
reexports %>%: Objects exported from other packages
byNotEmpty(): Apply Function Row-Wise With Null Protection
byNotEmptyAsDf(): Apply Function Row-Wise and Merge Results to Data Frame
convertImproveTimestampToPosix(): Convert Improve Timestamp to POSIX
getImproveInternalDir(): Get improve internal directory
getImproveWorkspaceDir(): Get improve workspace directory
getLogFile(): Get Log File
lastRestError(): Last REST Error
log_debug(): Log_debug
log_error(): Log_error
log_info(): Log_info
log_warn(): Log_warn
pwd(): Pwd
resetCache(): Reset Cache
strip(): Strip
unauthenticatedREST(): Unauthenticated REST

Cache Refresh (deprecated update* aliases)

Functions that clear and reload cached data. The update* variants are deprecated aliases for their refresh* counterparts.

refreshChildResources() updateChildResources(): Refresh Child Resources from Server
refreshChildSteps() updateChildSteps(): Refresh Child Steps from Server
refreshFullChildResources() updateFullChildResources(): refreshFullChildResources
refreshParentStep() updateParentStep(): Refresh Parent Step from Server
refreshParentalDescendant() updateParentalDescendant(): Refresh parental/descendant cache for a resource
refreshReviewComments() updateReviewComments(): Reloads the Review Comments for a Review
refreshReviewEntries() updateReviewEntries(): Reloads the Review Entries for a Review
refreshReviewers() updateReviewers(): Reloads the Reviewers for a Review
refreshReviews() updateReviews(): Reloads the Reviews
refreshFile() updateFile(): refreshFile
refreshResource() updateResource(): Refresh Resource