project-lib für R (veraltet)

Projektinformationen abrufen

Mit den folgenden Funktionen können Sie projektbezogene Informationen programmgesteuert abrufen.

• get_name()

  Diese Funktion gibt den Namen des Projekts zurück.

• get_description()

  Diese Funktion gibt die Beschreibung des Projekts zurück.

• get_metadata()

  Bei Verwendung dieser Funktion werden die Projektmetadaten zurückgegeben.

• get_files()

  Diese Funktion gibt eine Liste der Dateien in Ihrem Projekt zurück. Jedes Element in der zurückgegebenen Liste enthält die ID und den Namen der Datei. Die Liste der zurückgegebenen Dateien wird nicht nach einem Kriterium sortiert und kann sich ändern, wenn Sie die Funktion erneut aufrufen.

• get_assets()

  Diese Funktion gibt eine Liste aller Projekt-Assets zurück. Sie können den optionalen Parameter assetType an die Funktion get_assets übergeben, wodurch Sie Assets nach Typ filtern können. Die zulässigen Werte für diesen Parameter sind data_asset, connection und asset. Der Wert asset gibt alle Assets in Ihrem Projekt zurück. Um beispielsweise nur die Datenbestände abzurufen, verwenden Sie die Funktion get_assets("data_asset").

• get_connections()

  Diese Funktion gibt eine Liste der Verbindungen zurück, die in Ihrem Projekt vorhanden sind. Jedes Element in der zurückgegebenen Liste enthält die ID und den Namen der Verbindung.

Dateien abrufen

Mit der folgenden Funktion kannst du die in deinem Projekt gespeicherten Dateien abrufen.

• get_file(filename) wobei der Name filename der Datei ist, die Sie abrufen möchten.

  Bei Verwendung dieser Funktion wird eine Datei in den Hauptspeicher des aktiven Kernels abgerufen. Die Funktion gibt einen Byte-Puffer zurück, der zur Einbindung in kernelspezifische Datenstrukturen verwendet werden kann, beispielsweise in einen R-Datenrahmen. Diese Methode zum Abrufen von Dateien wird nicht für umfangreiche Dateien empfohlen.

  Das folgende Beispiel zeigt Ihnen, wie Sie eine Datei abrufen und die Daten in einen R-Datenrahmen einlesen können:

  # Import project lib
  library("projectLib")
  project <- access_project()
  
  # Fetch data
  my.file <- project$get_file("my_file.csv")
  
  # Read the CSV data file into a data frame
  df.data <-  read.csv(text = rawToChar(my.file))
  head(df.data)
  

Daten speichern

Mit der folgenden Funktion können Sie Daten als Datei im Projekt speichern. Diese Funktion erfüllt mehrere Aufgaben. Zunächst werden die Daten in eine Datei gespeichert und anschließend als Datenelement zu Ihrem Projekt hinzugefügt, sodass Sie die als Datei gespeicherten Daten in der Liste der Datenelemente Ihres Projekts sehen können.

• save_data(filename, data, setProjectAsset=TRUE, overwrite=FALSE)

  Die Funktion nimmt folgende Parameter entgegen:

  • filename: der Name der erstellten Datei.

  • data: die hochzuladenden Daten. Als Werte für diesen Parameter sind R-Rohobjekte oder Zeichenfolgenpuffer zulässig.

  • setProjectAsset[optional]: Fügt die Datei als Datenelement zum Projekt hinzu, nachdem die Daten erfolgreich in die Datei hochgeladen wurden. Es akzeptiert einen booleschen Wert, wobei standardmäßig der Wert „true“ gesetzt ist.

  • overwrite[optional]: überschreibt die Datei, falls diese bereits vorhanden ist. Standardmäßig ist diese Option auf „false“ gesetzt.

    Hier ist ein Beispiel, das Ihnen zeigt, wie Sie Daten in einer Datei speichern können:

    library("projectLib")
    project <- access_project()
    
    # Capture CSV data from console output
    csv_lines <- capture.output(write.csv(df.data, row.names=FALSE), type="output")
    csv_raw <- charToRaw(paste0(csv_lines, collapse='\n'))
    
    project$save_data("file.csv", csv_raw)
    

Daten aus einer Verbindung lesen

Mit der folgenden Funktion können Sie die Metadaten (Anmeldedaten) einer bestimmten Verbindung abrufen.

get_connection: Die Funktion erwartet als Eingabe entweder die ID der Verbindung oder den Namen der Verbindung. Sie können diese Werte mithilfe der get_assets() Funktion abrufen, die den id, name und type aller im Projekt aufgeführten Assets zurückgibt.

Die Funktion get_connection gibt die Verbindungsdaten zurück, mit denen Sie Daten aus der Datenquelle abrufen können.

Hier ist ein Beispiel, das zeigt, wie Sie die Anmeldedaten einer Verbindung mithilfe der get_connection Funktion abrufen können:

# Import project lib
library(projectLib)
project <- access_project()

# Fetch connection
conn.cred <- project$get_connection(name="<ConnectionName>")

Wenn es sich bei Ihrer Verbindung beispielsweise um eine Verbindung zu dashDB handelt, können Sie Ihre Daten abrufen, indem Sie den folgenden Code ausführen:

library(ibmdbR)

props <- paste("DASHDB;DATABASE=BLUDB;HOSTNAME=", conn.cred$host, ";PORT=50000;PROTOCOL=TCPIP;", sep="")
conn <- idaConnect(props, uid = conn.cred$username, pwd = conn.cred$password, conType = "odbc")
idaInit(conn)

idf.1 <- ida.data.frame('<TableName>')
head(idf.1)

Verbundene Daten abrufen

Mit der folgenden Funktion können Sie die Anmeldedaten der verbundenen Daten abrufen. Die Funktion gibt ein Wörterbuch zurück, das neben den Anmeldedaten für die Verbindung auch ein datapath Attribut enthält, das auf bestimmte Daten innerhalb dieser Verbindung verweist, beispielsweise auf eine Tabelle in einer Instanz von dashDB oder auf eine Datenbank in einer Instanz von Cloudant.

get_connected_data: Diese Funktion erwartet als Eingabe entweder die ID der verbundenen Daten oder den Namen der verbundenen Daten. Sie können diese Werte mithilfe der get_assets() Funktion abrufen, die den id, name und type aller im Projekt aufgeführten Assets zurückgibt.

Hier ist ein Beispiel, das zeigt, wie Sie mithilfe der get_connected_data Funktion die Anmeldedaten der verbundenen Daten in einer „ dashDB “-Instanz abrufen können:

# Import project lib
library(projectLib)
project <- access_project()

# Fetch credentials of the connected data
conn.data <- project$get_connected_data(id="<ConnectedDataId>")