Learn R Programming

⚠️There's a newer version (0.2.0) of this package.Take me there.

oncrawlR

Description

This R package implements methods for querying SEO data from OnCrawl and uses a basic authentication with an API key.

NB : To get this API key, you need to have a Oncrawl Business plan.

The script is explained step by step on my blog post Complete API guide with R (package).

Install

#CRAN R (official version) : Ongoing !
install.packages("oncrawlR")

#Github (dev version)
library(devtools)
devtools::install_github("voltek62/oncrawlR")

Getting started

Get your oncrawlR API key and load the oncrawlR package.

This key must be copied to the root of your project in a txt file : oncrawl_configuration.txt

token = YOURAPIKEY
debug = FALSE
api = https://app.oncrawl.com/api/v2/
library(oncrawlR)

Main oncrawlR functions

1. initAPI

This function can check your token.

initAPI("oncrawl_configuration.txt")

2. listProjects

This function provides a list of your projects.

listProjects <- listProjects()

3. listPages

This function provides a list of crawled pages of your website.

pages <- listPages(crawlId)
pages_fetched <- filter(pages,fetched=="True")

4. listLogs

This function lists of all urls in your logs.

logs <- listLogs(projectId)

Feedbacks

Questions and feedbacks welcome!

You want to contribute ? Open a pull request ;-) If you encounter a bug or want to suggest an enhancement, please open an issue.

Copy Link

Version

Install

install.packages('oncrawlR')

Monthly Downloads

204

Version

0.1.5

License

MIT + file LICENSE

Maintainer

Vincent Terrasi

Last Published

June 28th, 2019

Functions in oncrawlR (0.1.5)

listProjects

List all projects
listPages

List all pages from a crawl
getPageFields

List all available fields from a crawl
getCrawl

Get a crawl
oncrawlCreateSegmentation

Transform a character array of URLs into JSON file for OnCrawl platform
oncrawlExplainModel

Explain XGBoost Model by displaying each importance variables
listLogs

List all pages from logs monitoring
listLinks

List all links from a crawl
initAPI

Prepare Token for API calls
getProject

Get a project
oncrawlSplitURL

Split URLs
oncrawlTrainModel

Train XGBoost Model