ibm-watson-studio-lib para R

Obter informações do projeto ou do espaço

Enquanto desenvolvimento de código, você pode não saber os nomes exatos de ativos de dados ou conexões. As funções a seguir fornecem listas de ativos, a partir das quais você pode escolher as relevantes. Em todos os exemplos, você pode usar wslib$show(assets) para praticamente imprimir a lista. O índice de cada item é impresso em frente ao item.

• list_connections()

  Esta função retorna uma lista das conexões. A lista de conexões devolvidas não é classificada por nenhum critério e pode mudar quando você ligar para a função novamente. Você pode passar um item de lista em vez de um nome para get_connection function. Por exemplo:

  # Import the lib
  library("ibmWatsonStudioLib")
  wslib <- access_project_or_space()
  
  assets <- wslib$list_connections()
  wslib$show(assets)
  connprops <- wslib$get_connection(assets[0])
  

• list_connected_data()

  Esta função retorna os ativos de dados conectados. A lista de ativos de dados conectados retornados não é classificada por nenhum critério e pode mudar quando você chamar a função novamente. Você pode passar um item de lista em vez de um nome para a função get_connected_data .

• list_stored_data()

  Esta função retorna uma lista dos ativos de dados armazenados (arquivos de dados). A lista de ativos de dados devolvidos não é classificada por nenhum critério e pode mudar quando você chamar a função novamente. Você pode passar um item de lista em vez de um nome para as funções load_data e save_data .

  Nota: uma heurística é aplicada para distinguir entre ativos de dados conectados e ativos de dados armazenados. No entanto, pode haver casos em que um ativo de dados do tipo errado aparece nas listas retornadas.

• wslib$here Ao usar este ponto de entrada, você pode recuperar metadados sobre o projeto ou espaço com o qual a biblioteca está trabalhando. O ponto de entrada wslib$here fornece as seguintes funções:

  • get_name()

    Esta função retorna o nome do projeto ou espaço.

  • get_description()

    Esta função retorna a descrição do projeto ou do espaço.

  • get_ID()

    Esta função retorna o ID do projeto ou espaço.

  • get_storage()

    Esta função retorna informações de armazenamento para o projeto ou espaço.

Obter token de autenticação

Algumas tarefas requerem um token de autenticação. Por exemplo, se você quiser executar suas próprias solicitações na API Data and AI Common Core, precisará de um token de autenticação.

Você pode usar a seguinte função para obter o token do portador:

• get_current_token()

Por exemplo:

library("ibmWatsonStudioLib")
wslib <- access_project_or_space()
token <- wslib$auth$get_current_token()

Esta função retorna o token do portador que é usado atualmente pela biblioteca ibm-watson-studio-lib .

Observe que a opção de obter seu token de autenticação por meio da variável de ambiente USER_ACCESS_TOKEN para usar na API Data and AI Common Core em notebooks, scripts e aplicativos R Shiny está obsoleta e será removida em uma versão futura.

Buscar dados

Você pode usar as seguintes funções para buscar dados de um recurso de dados armazenado (um arquivo) em seu espaço de trabalho.

• load_data(asset_name_or_item, attachment_type_or_item = NULL)

  Esta função carrega os dados de um ativo de dados armazenado em um buffer de bytes. A função não é recomendada para arquivos muito grandes.

  A função recebe os seguintes parâmetros:

  • asset_name_or_item: (Obrigatório) Ou uma string com o nome de um ativo de dados armazenado ou um item como aqueles retornados por list_stored_data().

  • attachment_type_or_item: (Opcional) Tipo de anexo a carregar. Um ativo de dados pode ter mais de um anexo com dados. Sem esse parâmetro, o tipo de anexo padrão, a saber, data_asset é carregado. Especifique este parâmetro se o tipo de anexo não for data_asset. Por exemplo, se um ativo de dados de texto simples tem um perfil anexado a partir de Análise de Linguagem Natural, este pode ser carregado como tipo de anexo data_profile_nlu.

    Aqui está um exemplo que mostra como carregar os dados de um ativo de dados:

    # Import the lib
    library("ibmWatsonStudioLib")
    wslib <- access_project_or_space()
    
    # Fetch the data from a file
    my_file <- wslib$load_data("MyFile.csv")
    
    # Read the CSV data file into a data frame
    df <-  read.csv(text = rawToChar(my_file))
    head(df)
    

• download_file(asset_name_or_item, file_name = NULL, attachment_type_or_item = NULL)

  Esta função faz o downloads dos dados de um ativo de dados armazenados e armazena-o no arquivo especificado no sistema de arquivos do seu tempo de execução. O arquivo será sobrescrito caso já exista.

  A função recebe os seguintes parâmetros:

  • asset_name_or_item: (Obrigatório) Ou uma string com o nome de um ativo de dados armazenado ou um item como aqueles retornados por list_stored_data().

  • file_name: (Opcional) O nome do arquivo que os dados baixados são armazenados para. Ele é padronizado para o nome de anexo do ativo.

  • attachment_type_or_item: (Opcional) O tipo de anexo para download. Um ativo de dados pode ter mais de um anexo com dados. Sem esse parâmetro, o tipo de anexo padrão, a saber, data_asset é baixado. Especifique este parâmetro se o tipo de anexo não for data_asset. Por exemplo, se um ativo de dados de texto simples tem um perfil anexado a partir de Análise de Linguagem Natural, isso pode ser downlaoded carregado como tipo de anexo data_profile_nlu.

    Aqui está um exemplo que mostra como você pode usar download_file para disponibilizar o seu script de R personalizado em seu notebook:

    # Import the lib
    library("ibmWatsonStudioLib")
    wslib <- access_project_or_space()
    
    # Let's assume you have a R script "helpers.R" with helper functions on your local machine.
    # Upload the script to your project using the Data Panel on the right of the opened notebook.
    
    # Download the script to the file system of your runtime
    wslib$download_file("helpers.R")
    
    # Source the script to use the contained functions, e.g. ‘my_func’, in your notebook.
    source("helpers.R")
    my_func()
    

Salvar dados

As funções para armazenar dados em seu armazenamento do projeto fazem várias coisas:

• Armazenar os dados no armazenamento do projeto
• Adicione os dados como um recurso de dados (criando um recurso ou substituindo um recurso existente) ao seu espaço de trabalho para que você possa ver os dados na lista de recursos de dados do seu espaço de trabalho.
• Associe o ativo com o arquivo no armazenamento.

Você pode usar as seguintes funções para salvar dados:

• save_data(asset_name_or_item, data, overwrite = NULL, mime_type = NULL, file_name = NULL)

  Esta função salva os dados da memória no armazenamento da área de trabalho.

  A função recebe os seguintes parâmetros:

  • asset_name_or_item: (Obrigatório) O nome do ativo criado ou item de lista que é retornado por list_stored_data(). Você pode usar o item se você gosta de sobrescrever um arquivo existente.

  • data: (Obrigatório) Os dados para fazer upload. O tipo de dados esperado é raw.

  • overwrite: (Opcional) Sobe os dados de um ativo de dados armazenados se ele já existir. O valor padrão é FALSE. Se um item de ativo é passado em vez de um nome, o comportamento é para sobrescrever o ativo.

  • mime_type: (Opcional) O tipo MIME para o ativo criado. Por padrão o tipo MIME é determinado a partir do sufixo de nome do ativo. Se você usar nomes de ativos sem um sufixo, especifique o tipo MIME aqui. Por exemplo mime_type=application/text para dados de texto simples. Esse parâmetro é ignorado ao sobrescretar um ativo.

  • file_name: (Opcional) O nome do arquivo a ser usado no armazenamento da área de trabalho. Os dados são salvos no armazenamento associado ao espaço de trabalho. Ao criar um novo ativo, o nome do arquivo é derivado do nome do ativo, mas pode ser diferente Se você quiser acessar o arquivo diretamente, você pode especificar um nome de arquivo. Esse parâmetro é ignorado ao sobrescretar um ativo.

    Aqui está um exemplo que mostra como salvar dados em um arquivo:

    # Import the lib
    library("ibmWatsonStudioLib")
    wslib <- access_project_or_space()
    
    # let's assume you have a data frame df which contains the data
    # you want to save as a csv file
    csv <- capture.output(write.csv(df, row.names=FALSE), type="output")
    csv_raw <- charToRaw(paste0(csv, collapse='\n'))
    wslib$save_data("my_asset_name.csv", csv_raw)
    
    # the function returns a list which contains the asset_name, asset_id, file_name and additional information upon successful saving of the data
    

• upload_file(file_path, asset_name = NULL, file_name = NULL, overwrite = FALSE, mime_type = NULL)

  Esta função salva os dados do sistema de arquivos no tempo de execução em um arquivo associado à sua área de trabalho.

  A função recebe os seguintes parâmetros:

  • file_path: (Obrigatório) O caminho para o arquivo no sistema de arquivos.

  • asset_name: (Opcional) O nome do ativo de dados que é criado. Ele padronizado para o nome do arquivo a ser carregado.

  • file_name: (Opcional) O nome do arquivo criado no armazenamento associado ao espaço de trabalho. Ele padronizado para o nome do arquivo a ser carregado.

  • overwrite: (Opcional) Sobe um arquivo existente no armazenamento. O valor padrão é FALSE.

  • mime_type: (Opcional) O tipo MIME para o ativo criado. Por padrão o tipo MIME é determinado a partir do sufixo de nome do ativo. Se você usar nomes de ativos sem um sufixo, especifique o tipo MIME aqui. Por exemplo mime_type='application/text' para dados de texto simples. Esse parâmetro é ignorado ao sobrescretar um ativo.

    Aqui está um exemplo que mostra como você pode fazer upload de um arquivo para a área de trabalho:

    # Import the lib
    library("ibmWatsonStudioLib")
    wslib <- access_project_or_space()
    
    # Let's assume you have downloaded a file and want to save it
    # in your project.
    download.file("https://some/url/data_file.csv", "data_file.csv")
    wslib$upload_file("data_file.csv")
    
    # The function returns a list which contains the asset_name, asset_id, file_name and
    # additional information upon successful saving of the data.
    # The value `input_file_copied` tells you, if the file has been copied to project storage.
    # If the value is true, you can savely delete the local input file.
    # If the value is false, you should not delete the input file because it already
    # exists in the mounted project storage. Deleting the file
    # from the mounted project storage will corrupt the created asset.
    # The return value can be passed to load_data() to read back the data.
    

Obter informações de conexão

Você pode usar a seguinte função para acessar os metadados de conexão de uma determinada conexão.

• get_connection(name_or_item)

  Esta função retorna as propriedades (metadados) de uma conexão que você pode usar para buscar dados da fonte de dados de conexão. Use wslib$show(connprops) para visualizar as propriedades. A chave especial "." no item de lista devolvido fornece informações sobre o ativo de conexão.

  A função usa o seguinte parâmetro necessário:

  • name_or_item: Uma sequência com o nome de uma conexão ou um item como aqueles retornados por list_connections()

  Observe que ao trabalhar com blocos de notas, é possível clicar em Ler dados no painel Fragmentos de código para gerar código para carregar dados de uma conexão em um pandas DataFrame , por exemplo.

Obter informações de dados conectadas

Você pode usar a seguinte função para acessar os metadados de um ativo de dados conectado.

• get_connected_data(name_or_item)

  Esta função retorna as propriedades de um ativo de dados conectado, incluindo as propriedades da conexão subjacente. Use wslib$show() para visualizar as propriedades. A chave especial "." na lista devolvida fornece informações sobre os dados e os ativos de conexão.

  A função usa o seguinte parâmetro necessário:

  • name_or_item: uma sequência com o nome de um ativo de dados conectado ou um item como aqueles retornado por list_connected_data().

  Observe que ao trabalhar com blocos de notas, é possível clicar em Ler dados no painel Fragmentos de código para gerar código para carregar dados de um ativo de dados conectado em um pandas DataFrame por exemplo.

Ativo de acesso por ID em vez de nome

Você deve, preferencialmente, sempre acessar ativos de dados e conexões por um nome exclusivo. Os nomes de ativos não são necessariamente sempre únicos e as funções ibm-watson-studio-lib levantarão uma exceção quando um nome é ambíguo. É possível renomear ativos de dados na UI para resolver o conflito.

É possível acessar ativos por meio de um ID exclusivo, mas isso não é recomendado, pois os IDs são válidos apenas no espaço de trabalho atual e quebrarão o código quando transferidos para um espaço de trabalho diferente. Isso pode acontecer por exemplo, quando os projetos são exportados e reimportados, ou quando notebooks ou ativos são promovidos de projetos para espaços. Você pode obter o ID de uma conexão, ativo de dados conectado ou armazenado usando a função de lista correspondente, por exemplo list_connections().

O ponto de entrada wslib$by_id fornece as seguintes funções:

• get_connection(asset_id)

  Esta função acessa uma conexão pelo ID do ativo de conexão.

• get_connected_data(asset_id)

  Esta função acessa um ativo de dados conectado pelo ID de ativo de dados conectado.

• load_data(asset_id, attachment_type_or_item = NULL)

  Esta função carrega os dados de um ativo de dados armazenado passando o ID do ativo. Veja load_data() para uma decsrição dos outros parâmetros que você pode passar.

• save_data(asset_id, data, overwrite = NULL, mime_type = NULL, file_name = NULL)

  Esta função salva dados a um ativo de dados armazenado passando o ID do ativo. Isso implica overwrite=TRUE. Veja save_data() para uma descrição dos outros parâmetros que você pode passar.

• download_file(asset_id, file_name = NULL, attachment_type_or_item = NULL)

  Esta função faz o downloads dos dados de um ativo de dados armazenado passando o ID do ativo. Veja download_file() para uma descrição dos outros parâmetros que você pode passar.

Trabalhe com o armazenamento do projeto montado

O tempo de execução no qual o seu código está em execução pode tornar os ativos de dados disponíveis como arquivos simples em um sistema de arquivos montado usando o ponto de entrada wslib.mount. Por exemplo, o projeto ou armazenamento de espaço é montado nas runtimes do notebook. Nesse caso, o acesso aos ativos de dados pode ser mais eficiente por meio da leitura direta do arquivo em vez de copiar o conteúdo.

As funções a seguir podem ser usadas se a função mount.is_available() retornar True. Se a função retornar False e o sistema de arquivos contendo os ativos de dados não for montado, você poderá trabalhar com seus dados usando as funções descritas em Dados de busca e Salvar dados.

• is_available()

  Esta função verifica se o armazenamento do projeto está disponível como uma montagem no sistema de arquivos local.

• get_base_dir()

  Esta função retorna o caminho absoluto para a pasta de ativos de dados no sistema de arquivos local.

• get_data_path(asset_name_or_item)

  Esta função retorna o caminho absoluto do arquivo referenciado por um ativo de dados no sistema de arquivos local.

  A função assume o seguinte parâmetro:

  • name_or_item: (Obrigatório) Ou uma string com o nome de um ativo de dados armazenado ou um item como aqueles retornados por list_stored_data().

• register_asset(file_path, asset_name = NULL, mime_type = NULL)

  Esta função registra o arquivo na montagem local como um ativo de dados em seu projeto ou espaço. Esta operação falha se um ativo de dados com o mesmo nome já existir.

  A função recebe os seguintes parâmetros:

  • file_path: (Obrigatório) O caminho absoluto para o arquivo no projeto montado localmente ou armazenamento de espaço.

  • asset_name: (Opcional) O nome do ativo criado. Ele é padronizado para o nome do arquivo.

  • mime_type: (Opcional) O tipo MIME para o ativo criado. Por padrão o tipo MIME é determinado a partir do sufixo de nome do ativo. Use este parâmetro para especificar um tipo MIME se o seu nome de arquivo não tiver uma extensão de arquivo ou se você quiser configurar um tipo MIME diferente.

    O exemplo a seguir mostra como registrar um arquivo no armazenamento do projeto montado como um ativo:

    # Import the lib
    library("ibmWatsonStudioLib")
    wslib <- access_project_or_space()
    
    # Let's assume you have a really large file that you cannot
    # upload to your project via ‘save_data()’ or ‘upload_file()’,
    # because those methods require the data to fit into memory.
    my_large_file <- "my_large_file.csv"
    
    # Copy the file to the data assets folder in the
    # mounted project storage:
    data_asset_folder <- wslib$mount$get_base_dir()
    target_path <- file.path(data_asset_folder, my_large_file)
    file.copy(my_large_file, target_path)
    
    # Register the file as data asset
    wslib$mount$register_asset(target_path, asset_name="LargeFile.csv")
    
    # the function returns a list which contains the asset_name, asset_id, file_name and additional information upon successful creation of the data asset.
    

  Nota: é possível registrar um arquivo várias vezes como um ativo de dados diferente.. A exclusão de um desses ativos na interface do projeto também exclui o arquivo em storage o que significa que outras referências de ativos para o arquivo podem ser quebradas.

Armazenamento do projeto de acesso diretamente

Você pode buscar dados do armazenamento do projeto e armazenar dados em armazenamento de projetos sem sincronizar os ativos do projeto usando o ponto de entrada wslib$storage.

O projeto ou armazenamento de espaço é montado no tempo de execução do notebook e você normalmente usará o ponto de entrada wslib$mount e as operações do sistema de arquivos para acessar o armazenamento.

O ponto de entrada wslib$storage fornece as seguintes funções:

• fetch_data(filename)

  Esta função retorna os dados em um arquivo como um buffer de bytes. O arquivo não precisa ser registrado como ativo de dados.

  A função usa o seguinte parâmetro necessário:

  • filename: O nome do arquivo no projeto ou armazenamento de espaço.

• store_data(filename, data, overwrite = FALSE)

  Esta função salva dados em memória ao armazenamento, mas não cria um novo ativo de dados. A função retorna uma lista que contém o nome do arquivo, caminho de arquivo e informações adicionais. Use Use wslib$show() para imprimir as informações.

  A função recebe os seguintes parâmetros:

  • filename: (Obrigatório) O nome do arquivo no armazenamento da área de trabalho.
  • data: (Obrigatório) Os dados para salvar como um objeto bruto.
  • overwrite: (Opcional) Substitui os dados de um arquivo no armazenamento se ele já existir. Por padrão, isso é configurado como falso.

• download_file(storage_filename, local_filename = NULL)

  Esta função faz o downloads dos dados em um arquivo em storage e armazena-o no arquivo local especificado. O arquivo local é sobrescrito se ele já existia.

  A função recebe os seguintes parâmetros:

  • storage_filename: (Obrigatório) O nome do arquivo em storage para download.
  • local_filename: (Opcional) O nome do arquivo no sistema de arquivos local do seu tempo de execução para download do arquivo para. Omitia este parâmetro para usar o nome do arquivo de armazenamento.

• register_asset(storage_path, asset_name = NULL, mime_type = NULL)

  Esta função registra o arquivo no armazenamento como um ativo de dados em sua área de trabalho. Esta operação falha se um ativo de dados com o mesmo nome já existir.

  A função recebe os seguintes parâmetros:

  • storage_path: (Obrigatório) O caminho do arquivo no armazenamento.
  • asset_name: (Opcional) O nome do ativo criado. Ele é padronizado para o nome do arquivo.
  • mime_type: (Opcional) O tipo MIME para o ativo criado. Por padrão o tipo MIME é determinado a partir do sufixo de nome do ativo. Use este parâmetro para especificar um tipo MIME se o seu nome de arquivo não tiver uma extensão de arquivo ou se você quiser configurar um tipo MIME diferente.
  Nota: é possível registrar um arquivo várias vezes como um ativo de dados diferente.. A exclusão de um desses ativos no projeto também exclui o arquivo em storage, o que significa que outras referências de ativos para o arquivo podem ser quebradas.

Navegar ativos do projeto

O ponto de entrada wslib$assets fornece acesso genérico, de leitura, a ativos de qualquer tipo. Para os tipos de ativos selecionados, há funções dedicadas que fornecem dados adicionais.

Aplicam-se as seguintes convenções de nomenclatura:

• Funções nomeadas list_<something> retornam uma lista de listas nomeadas. Cada lista contida representa um ativo e inclui um pequeno conjunto de propriedades (metadados) que identifica o ativo.
• Funções nomeadas get_<something> retornam uma única lista nomeada com as propriedades para o ativo.

Para bonito-imprimir uma lista ou lista de listas denominadas, use wslib$show().

As funções esperam o nome de um ativo, ou um item de uma lista como o parâmetro. Por padrão, as funções retornam apenas um subconjunto das propriedades de ativos disponíveis. Ao configurar o parâmetro raw_info=TRUE, é possível obter o conjunto completo de propriedades do ativo.

O ponto de entrada wslib$assets fornece as seguintes funções:

• list_assets(asset_type, name = NULL, query = NULL, selector = NULL, raw_info = FALSE)

  Esta função lista todos os ativos para o tipo determinado com relação às restrições dadas.

  A função recebe os seguintes parâmetros:

  • asset_type: (Obrigatório) O tipo de ativos a listar, por exemplo data_asset. Veja list_asset_types() para obter uma lista dos tipos de ativos disponíveis. Use o tipo de ativo asset para obter a lista de todos os ativos disponíveis na área de trabalho.

  • name: (Opcional) O nome do ativo a listar. Use este parâmetro se existir mais de um ativo com o mesmo nome. Você só pode especificar name e query.

  • query: (Opcional) Uma string de consulta que é passada para a API Data and AI Common Core para pesquisar ativos. Você só pode especificar name e query.

  • selector: (Opcional) Uma função de filtro personalizado nos itens da lista de ativos do candidato. Se a função seletora retornar TRUE, o ativo será incluído na lista de ativos devolvidos.

  • raw_info: (Opcional) Retorna todos os metadados disponíveis. Por padrão, o parâmetro é configurado como FALSE e apenas um subconjunto das propriedades é retornado.

    Exemplos de uso da função list_assets :

    # Import the lib
    library("ibmWatsonStudioLib")
    wslib <- access_project_or_space()
    
    # List all assets in the project or space
    all_assets <- wslib$assets$list_assets("asset")
    wslib$show(all_assets)
    
    # List all data assets with name 'MyFile.csv'
    assets_by_name <- wslib$assets$list_assets("data_asset", name = "MyFile.csv")
    
    # List all data assets whose name starts with "MyF"
    assets_by_query <- wslib$assets$list_assets("data_asset", query = "asset.name:(MyF*)")
    
    # List all data assets which are larger than 1 MB
    sizeFilter <- function(asset) asset$metadata$size > 1000000
    large_assets <- wslib$assets$list_assets("data_asset", selector = sizeFilter, raw_info = TRUE)
    wslib$show(large_assets)
    
    # List all notebooks
    notebooks <- wslib$assets$list_assets("notebook")
    

• list_asset_types(raw_info = FALSE)

  Esta função lista todos os tipos de ativos disponíveis.

  A função pode usar o seguinte parâmetro:

  • raw_info: (Opcional) Retorna o conjunto completo de metadados. Por padrão, o parâmetro é FALSE e apenas um subconjunto das propriedades é retornado.

• list_datasource_types(raw_info = FALSE)

  Esta função lista todos os tipos de origem de dados disponíveis.

  A função pode usar o seguinte parâmetro:

  • raw_info: (Opcional) Retorna o conjunto completo de metadados. Por padrão, o parâmetro é FALSE e apenas um subconjunto das propriedades é retornado.

• get_asset(name_or_item, asset_type=None, raw_info = FALSE)

  A função retorna os metadados de um ativo.

  A função recebe os seguintes parâmetros:

  • name_or_item: (Obrigatório) O nome do ativo ou um item como aqueles retornados por list_assets()

  • asset_type: (Opcional) O tipo do ativo. Se o parâmetro name_or_item contém uma string para o nome do ativo, configurar asset_type é necessário.

  • raw_info: (Opcional) Retorna o conjunto completo de metadados. Por padrão, o parâmetro é FALSE e apenas um subconjunto das propriedades é retornado.

    Exemplo de uso das funções list_assets e get_asset :

    notebooks <- wslib$assets$list_assets("notebook")
    wslib$show(notebooks)
    
    notebook <- wslib$assets$get_asset(notebooks[[1]])
    wslib$show(notebook)
    

• get_connection(name_or_item, with_datasourcetype=False, raw_info = FALSE)

  Esta função retorna os metadados de uma conexão.

  A função recebe os seguintes parâmetros:

  • name_or_item: (Obrigatório) O nome da conexão ou um item como aqueles retornados por list_connections()
  • with_datasourcetype: (Opcional) Retorna informações adicionais sobre o tipo de origem de dados da conexão.
  • raw_info: (Opcional) Retorna o conjunto completo de metadados. Por padrão, o parâmetro é FALSE e apenas um subconjunto das propriedades é retornado.

• get_connected_data(name_or_item, with_datasourcetype=False, raw_info = FALSE)

  Esta função retorna os metadados de um ativo de dados conectado.

  A função recebe os seguintes parâmetros:

  • name_or_item: (Obrigatório) O nome do ativo de dados conectado ou um item como aqueles retornados por list_connected_data()
  • with_datasourcetype: (Opcional) Retorna informações adicionais sobre o tipo de origem de dados do ativo de dados conectado associado.
  • raw_info: (Opcional) Retorna o conjunto completo de metadados. Por padrão, o parâmetro é FALSE e apenas um subconjunto das propriedades é retornado.

• get_stored_data(name_or_item, raw_info = FALSE)

  Esta função retorna os metadados de um ativo de dados armazenado.

  A função recebe os seguintes parâmetros:

  • name_or_item: (Obrigatório) O nome do ativo de dados armazenados ou um item como aqueles retornados por list_stored_data()
  • raw_info: (Opcional) Retorna o conjunto completo de metadados. Por padrão, o parâmetro é FALSE e apenas um subconjunto das propriedades é retornado.

• list_attachments(name_or_item_or_asset, asset_type=None, raw_info = FALSE)

  Esta função retorna uma lista dos anexos de um ativo.

  A função recebe os seguintes parâmetros:

  • name_or_item_or_asset: (Obrigatório) O nome do ativo ou um item como aqueles retornados por list_stored_data() ou get_asset().

  • asset_type: (Opcional) O tipo do ativo. Ele é padronizado para digitar data_asset.

  • raw_info: (Opcional) Retorna o conjunto completo de metadados. Por padrão, o parâmetro é FALSE e apenas um subconjunto das propriedades é retornado.

    Exemplo de uso da função list_attachments para ler um anexo de um ativo de dados armazenado:

    assets <- wslib$list_stored_data()
    wslib$show(assets)
    
    asset <- assets[[1]]
    attachments <- wslib$assets$list_attachments(asset)
    wslib$show(attachments)
    buffer <- wslib$load_data(asset, attachments[[1]])