README.Rmd

microdemic
==========

```{r echo=FALSE}
knitr::opts_chunk$set(
  warning = FALSE,
  message = FALSE,
  collapse = TRUE,
  comment = "#>"
)
```

[![cran checks](https://cranchecks.info/badges/worst/microdemic)](https://cranchecks.info/pkgs/microdemic)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![R-check](https://github.com/ropensci/microdemic/workflows/R-check/badge.svg)](https://github.com/ropensci/microdemic/actions?query=workflow%3AR-check)
[![codecov](https://codecov.io/gh/ropensci/microdemic/branch/master/graph/badge.svg)](https://codecov.io/gh/ropensci/microdemic)
[![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/microdemic)](https://github.com/r-hub/cranlogs.app)
[![cran version](https://www.r-pkg.org/badges/version/microdemic)](https://cran.r-project.org/package=microdemic)

`microdemic` - Microsoft Academic Client

Web interface: https://academic.microsoft.com/

API docs:
- https://docs.microsoft.com/en-us/azure/cognitive-services/academic-knowledge/
- https://msr-apis.portal.azure-api.net/docs/services/academic-search-api/operations/565d9001ca73072048922d97

Get a API key at https://msr-apis.portal.azure-api.net/signin

## install

cran version

```{r eval=FALSE}
install.packages("microdemic")
```

dev version

```{r eval=FALSE}
remotes::install_github("ropensci/microdemic")
```

```{r}
library("microdemic")
```

## Evaluate

See the [query expression syntax](https://docs.microsoft.com/en-us/azure/cognitive-services/academic-knowledge/queryexpressionsyntax)
for help on how to construct queries - for this and other functions

```{r}
ma_evaluate(query = "Y='19'...")
```

## Calchistogram

```{r}
res <- ma_calchist(query = "And(Composite(AA.AuN=='jaime teevan'),Y>2012)",
   atts = c('Y', 'F.FN'))
res$histograms$histogram
```

## Abstract

```{r}
ma_abstract(query = "Y='19'...", count = 5)
```


## Meta

* Please [report any issues or bugs](https://github.com/ropensci/microdemic/issues).
* License: MIT
* Get citation information for `microdemic` in R doing `citation(package = 'microdemic')`
* Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.

[![ropensci_footer](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org)