Cliente R para a API Ficharium Cloud • fichaR

Cliente R para o Ficharium Cloud. Permite autenticar, listar projetos, modelos e fichas de campo, e acessar listas de espécies consolidadas.

Instalação

# via remotes (recomendado)
remotes::install_github("biosensu/fichaR")

Autenticação

O token JWT é armazenado no .Renviron e reutilizado entre sessões.

library(fichaR)

# Login — abre prompt seguro de senha
ficharium_login("seu@email.com")

Projetos

# listar todos os projetos do usuário
projetos <- listar_projetos()

# detalhes de um projeto
proj <- projeto(projetos$id[1])

# modelos e fichas de um projeto
modelos_projeto("proj_id")
fichas_projeto("proj_id")

Modelos e campos

# modelos do usuário
modelos <- listar_modelos()

# campos de um modelo (com tipos R mapeados)
campos <- campos_modelo(modelos$id[1])

Fichas de campo

# tibble com uma linha por observação
fichas <- listar_fichas("proj_id", "modelo_id")

# ficha específica (campos resolvidos para nomes)
ficha("ficha_id")

Expandindo campos complexos

Campos de tipo especie, coordenada e ponto são retornados como list-columns. Use as funções auxiliares para expandi-los:

fichas |> expandir_especies("Espécie")
fichas |> expandir_coordenadas("Coordenadas")
fichas |> expandir_ponto("Ponto amostral")

Espécies

# lista consolidada de espécies registradas no projeto
especies <- listar_especies("proj_id")

# com filtro por nome
listar_especies("proj_id", busca = "Leopardus")

Configuração avançada

Defina no .Renviron para sobrescrever os padrões:

FICHARIUM_TOKEN=seu_token_jwt
FICHARIUM_BASE_URL=https://api.ficharium.cloud

Referência

A documentação completa de cada função — parâmetros, tipos de retorno e exemplos — está disponível em biosensu.github.io/fichaR/reference.

fichaR