https://github.com/ThinkR-open/togglr

an R and Rstudio wrapper for toggl Api
https://github.com/ThinkR-open/togglr

hacktoberfest r toggl-api toggler

Last synced: 3 months ago
JSON representation

an R and Rstudio wrapper for toggl Api

• Host: GitHub
• URL: https://github.com/ThinkR-open/togglr
• Owner: ThinkR-open
• Created: 2016-12-03T17:18:12.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-02-19T14:56:54.000Z (about 1 year ago)
• Last Synced: 2024-11-28T21:53:03.447Z (3 months ago)
• Topics: hacktoberfest, r, toggl-api, toggler
• Language: R
• Homepage: https://thinkr-open.github.io/togglr/
• Size: 7.91 MB
• Stars: 49
• Watchers: 5
• Forks: 18
• Open Issues: 9
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md

Awesome Lists containing this project

• jimsghstars - ThinkR-open/togglr - an R and Rstudio wrapper for toggl Api (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%",

  eval = FALSE

)

```

  

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/togglr)](https://cran.r-project.org/package=togglr)

[![](http://cranlogs.r-pkg.org/badges/togglr)](https://cran.r-project.org/package=togglr)

  [![R-CMD-check](https://github.com/ThinkR-open/togglr/workflows/R-CMD-check/badge.svg)](https://github.com/ThinkR-open/togglr/actions)

  

 

# togglr

An R and Rstudio wrapper for toggl Api.

Documentation site: https://thinkr-open.github.io/togglr/

## Installation of `togglr`

### From CRAN

```{r}

install.packages("togglr")

```

### From Github

```R

if (!requireNamespace("remotes")){install.packages("remotes")}

remotes::install_github("ThinkR-open/togglr")

```

## Set toggl Api token

Go on toogl.com website : `https://track.toggl.com/profile`

```{r}

togglr::open_toggl_website_profile()

```

then select and copy your token api at the bottom of the page.

```{r}

library(togglr)

set_toggl_api_token("your_token_api")

```

You just need to do this once.

## Start the tracking system

Without any parameters it will create a new project using your Rstudio project name. 

```{r}

toggl_start()

```

By default the client name is "without client" you can choose (and eventualy create a client) by using :

```{r}

toggl_start(client = "my client")

```

But you can also choose the task and the project

```{r}

toggl_start(client = "my client",

            description = "what I'm doing",

            project_name = "my project")

```

## Stop the tracking system

```{r}

toggl_stop()

```

## Get total time passed on the current project

```{r}

get_current_duration()# the current track

get_current_project_task_detail()# (including the current track)

```

## Get all your dashboard

```{r}

get_dashboard()

```

## Use Rstudio Addins

This package comes with 2 Rstudio addins 'start toggl' and 'stop toggl', feel free to use keybindings for convenience.

## Some other uselfull functions are in this package

```{r}

ls(package:togglr)

```