# Vectice R API cheatsheet This API guide provides a quick overview of Vectice's simple R API calls to help you get started auto-documenting your datasets, models, and notes. {% hint style="info" %} Be sure to [create your API key](https://docs.vectice.com/24.4/log-and-manage-assets-with-vectice-api/connect-to-api) first! {% endhint %} ## Install Vectice Start by installing the Vectice library. ```r # Install reticulate if not already installed install.packages("reticulate") # Install the latest Vectice library reticulate::py_install("vectice", pip = TRUE) # Or install a specific version of Vectice reticulate::py_install("vectice==", pip = TRUE) ``` ## Connect to Vectice Get started by connecting to the Vectice API and starting an iteration. ```r #import and connect to Vectice vectice <- reticulate::import("vectice") connect <- vectice$connect( api_token = 'your-api-key', # Paste your api key host = 'https://app.vectice.com', # Paste your host ) # Connect to your project phase using your phase ID phase = connect$phase("PHA-XXX") #You can fetch the relevant phase ID from your chosen Vectice project in the app. #Create an iteration iteration <- phase$create_or_get_current_iteration() ``` ## Auto-document your assets Auto-document your notes, datasets, and models directly to Vectice. ### Auto-document NOTES ```r # Auto-document your first comments or notes iteration$log("this is a comment") ``` ### Auto-document DATASETS {% tabs %} {% tab title="Local file" %} ```r # Auto-document your first dataset from a local file ds_resource <- vectice$FileResource(paths, dataframes) raw_ds <- vectice$Dataset$origin(name=name, resource=ds_resource, attachments = attachments) iteration$log(raw_ds) ``` {% endtab %} {% endtabs %} ### Auto-document MODELS {% tabs %} {% tab title="Default" %}

# Auto-document your first model
model <- vectice$Model(library, technique, metrics, properties, name, attachments, predictor)
iteration$log(model)

{% endtab %} {% endtabs %} ## Close your iteration Once you are done logging your assets for an iteration, mark it complete. ```r # Completes and closes the current iteration once you are happy with it iteration$complete() ``` ## Additional resources


Vectice R Sample	Learn how you can use Vectice with R!			https://github.com/vectice/Customer-Success/blob/develop/RStudio%20Sample/Vectice_R_Sample.R	Screen Shot 2023-10-19 at 1.23.07 PM.png

--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.vectice.com/24.4/log-and-manage-assets-with-vectice-api/api-cheatsheets/vectice-r-api-cheatsheet.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.