Package index • improveR

Step and workflow management

attachStep(): Attach a Step to a Parent Step
changeStepDescription(): Change Step Description
changeStepRationale(): Change Step Rationale
createStepEnv(): Create Step Environment
createStepTemplateEnv(): Create a Step Template Environment
createWorkflow(): Create New Workflow Environment
createWorkflowTemplateEnv(): Create a workflow template environment from an existing workflow
detachStep(): Detach Step from Parent
finishRunResource(): Wait for Step Execution to Finish
getStep(): Get Step Environment
getStepTemplate(): Create Step Template
getToolInstances(): Get Tool Instances
resetToolInstances(): Reset Tool Instance Cache
runStepResource(): Run a Step Resource
terminateStepResource(): Terminate a Running Step Resource
createAnalysisTree(): Create Analysis Tree in improve Repository
workflowTemplateFromJSON(): Load workflow template from JSON file

Authentication

clearConnectionData(): Clear Connection Data
improveClose(): improveClose
improveConnect(): improveConnect
improveConnected(): improveConnected
improveDisconnect(): improveDisconnect
improveEditable(): Verify Write Mode is Enabled (Guard Function)
improveOAuth(): Improve OAuth
refreshToken(): Refresh token using registered refresher
setEditable(): Enable or Disable Repository Write Mode

Review

createReview(): Creates a New Review
createReviewComment(): Creates a Comment for a Review
createReviewEntry(): Creates Review Entries For A Review
createReviewEntryComment(): Creates a Comment for a Review Entry
createReviewer(): Adds a User as Reviewer to a Review
getReviewComments(): Get Review Comments
getReviewEntries(): Get Review Entries
getReviewEntryComments(): Get Review Etnry Comments
getReviewers(): Get Reviewers
loadReviewComments(): Loads All The Review Comments For A Review it uses caching the result is returned as a data frame
loadReviewEntries(): Loads All The Review Entries For A Review it uses caching the result is returned as a data frame
loadReviewEntryComments(): Loads All The Comments For A Review Entry it uses caching the result is returned as a data frame
loadReviewers(): Loads All The Reviewers For A Review it uses caching the result is returned as a data frame
loadReviews(): Loads All Registered Reviews it uses caching the result is returned as a data frame
loadRunserver(): Loads Runserver By Label

Meta Data and Resource Relations

addBulkMetaDate(): Adds Metadata Value To A Resource, Always Adds, Never Updates
addMetaDate(): Adds Metadata Value To A Resource, Always Adds, Never Updates
createResourceRelation(): Creates a New Resource Relation
deleteMetaDate(): Deletes Metadata From A Resource
deleteResourceRelation(): Deletes a Resource Relation

CLI tools

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

Basic modify operations

copy(): Copy Resources to Target Location
delete(): Delete Resources Permanently
deleteReviewEntry(): Deletes All Review Entries From A Review
deleteReviewer(): Removes a Reviewer from a Review
move(): Move Resources to Target Location
createFile(): Create File in improve Repository
createFolder(): Create Folder in improve Repository
createLink(): Create Link to Resource
createExternalLink(): Create External Link in improve Repository

Miscellaneous

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
createWorkflowTemplateForImport(): Create a workflow template environment specifically for import operations
exportWorkflow(): Export a Workflow to a Portable Zip File
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
importWorkflow(): Import a Workflow from a zip File into a Repository Folder
includeGraphics(): Include Graphics in Knitr Chunk
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
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
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"
loadParentalDescendant(): Load the parental/descendant relationships of a resource
loadParentStep(): Loads the Parent Step of One Step, Not Applicable to Multiple Steps
loadResource(): Load Resource
lockResource(): Lock Resource for Exclusive Editing
query(): Search Resources Using Elasticsearch Query
queryFolder(): Search Resources Within a Folder Using Elasticsearch Query
resetCache(): Reset Cache
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
unloadHistory(): unloadHistory
unloadMetaData(): Unload Meta Data
unloadMetaDataDefinitions(): Unload Meta Data Definitions
unloadParentalDescendant(): Unload parental/descendant cache for a resource
unloadParentStep(): Unload Parent Step
unlockResource(): Unlock Resource to Allow Collaborative Access
updateFileContent(): Update File Content Prerequisite: must be a file. Multiple files can be updated at once.
updateHistory(): updateHistory
updateMetaData(): Update Meta Data
updateMetaDataDefinitions(): Update Meta Data Definitions
updateParentalDescendant(): Update parental/descendant cache for a resource
updateParentStep(): UpdateParentStep Reloads The Runservers From The Repository
uploadFolder(): Upload a Complete Folder Prerequisite: must be a folder.
whoami(): Get Current Authenticated User

Other

reexports %>%: Objects exported from other packages
applyTokenData(): Apply token data to session
checkConnect(): checkConnect
effectiveRights(): Get Effective User Rights for Resource
getActiveTokenRefresher(): Get active token refresher
getCopy(): Get a Local Copy of a File
getCurrentTokenData(): Get current token data
getFile(): Get a File Object
getFilesFromFolder(): Retrieve a List of Files from a Folder
getFullFolderAuditTrail(): Retrieve Recursive Audit Trail For A Specific Folder
getImproveInternalDir(): Get improve internal directory
getImproveWorkspaceDir(): Get improve workspace directory
getLogFile(): Get Log File
getMainProcess(): Get Main Process for a Step
getMetaData(): Gets a Metadata Data Frame
getMetaDataMap(): Loads the Metadata of a Given Resource and Writes It as String Values Into a List
getParent(): Returns the Parent of Anything Resolved by GetCorrectId
getProcessFileVariables(): Get Process File Variables
getRepositoryVersion(): Get Repository Version
getWorkflow(): Load Workflow Environment
improveInit(): Initialize R Modules from improve Repository
isFileUp2Date(): isFileUp2Date
isResourceUp2Date(): Is Resource Up2 Date
listTokenRefreshers(): List registered token refreshers
loadAuditTrail(): Load Audit Trail
loadChildResources(): Load Child Resources
loadChildSteps(): Load Child Steps
loadFile(): Load File
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
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
loadRelationTypes(): Loads All Registered Relation Types
loadResourceFromServer(): Load Resource From Server
loadResourceRelations(): Loads All Registered Resource Relations 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 ident can be a list
loadResourceVersionFromServer(): Load Resource Version From Server
log_debug(): Log_debug
log_error(): Log_error
log_info(): Log_info
log_warn(): Log_warn
pwd(): Pwd
registerTokenRefresher(): Register a token refresher plugin
shouldRefreshToken(): Check if token should be refreshed
strip(): Strip
unauthenticatedREST(): Unauthenticated REST
unloadAuditTrail(): Unload Audit Trail from Cache
unloadChildResources(): Unload Child Resources from Cache
unloadChildSteps(): Unload Child Steps from Cache
unloadFile(): unloadFile
unloadFullChildResources(): unloadFullChildResources
unloadReferences(): Unload References
unloadRelationTypes(): Unloads All Relation Types
unloadResource(): Unload Resource
unloadResourceRelations(): Unloads All Resource Relations
unloadReviewComments(): Unloads the Review Comments for a Review
unloadReviewEntries(): Unloads the Review Entries for a Review
unloadReviewEntryComments(): Unloads the Comments for a Review Entry
unloadReviewers(): Unloads the Reviewers for a Review
unloadReviews(): Unloads All Reviews
updateAccessToken(): Update access token in current session
updateAuditTrail(): Update Audit Trail from Server
updateChildResources(): Update Child Resources from Server
updateChildSteps(): Update Child Steps from Server
updateFile(): updateFile
updateFullChildResources(): updateFullChildResources
updateLinks(): Update Link Resources to Latest Target Version
updateMetaData(): Update Meta Data
updateMetaDate(): Updates Metadata Value To A Resource
updateMetaDateById(): Updates Metadata Value To A Resource
updateParentStep(): UpdateParentStep Reloads The Runservers From The Repository
updateReferences(): Update References
updateRelationTypes(): Reloads the Relation Types
updateResource(): Update Resource
updateResourceRelation(): Updates a Resource Relation
updateResourceRelations(): Reloads the Resource Relations
updateReviewComments(): Reloads the Review Comments for a Review
updateReviewEntries(): Reloads the Review Entries for a Review
updateReviewEntryComments(): Reloads the Comments for a Review Entry
updateReviewers(): Reloads the Reviewers for a Review
updateReviews(): Reloads the Reviews
users(): List All Users in improve Repository
getTokenRefresher(): Get registered token refresher