ropensci-archive / microdemic Goto Github PK

View Code? Open in Web Editor NEW

16.0 6.0 2.0 287 KB

:warning: ARCHIVED :warning: microsoft academic client

License: Other

R 95.55% Makefile 4.45%

api-client scholarly-articles scholarly-metadata rstats r r-package text-mining

microdemic's Introduction

This package has been archived. The former README is now in README-not.<

microdemic's People

Contributors

Stargazers

Watchers

Forkers

crew102 ivanhb

microdemic's Issues

vcr tests

Microsoft academic moving away from E

https://docs.microsoft.com/en-us/academic-services/project-academic-knowledge/reference-extended-removal

Make sure docs have sufficient info on how to get API keys

What does "Unknown or uninitialised column:" means?

Hi!

Thanks for this great package. Unfortunately, I don't use R very often, so I'm not sure what is the problem here.

When I query a search for a paper abstract I get the following errors:

# A tibble: 0 x 1
# ... with 1 variable: abstract <chr>
Warning messages:
1: Unknown or uninitialised column: 'E'. 
2: Unknown or uninitialised column: 'Id'.

Is this a missing entry in Microsoft Academics, or do I need to "initialize" columns E + Id?

For instance, I get the error when I execute:

ma_abstract(query = "Ti='Reversible gene knockdown in mice using a tight, inducible shRNA expression system'")

Thanks!

invabs2abs is inserting "NA" into abstracts

The inverted index that the API serves sometimes has missing values. For example, the index may provide information about the tokens at locations 0, 2, and 3, but not location 1 (e.g., "InvertedIndex":{"i":[0],"big":[2], "dogs":[3]}.)

invabs2abs(), however, assumes that there is a token for each location. This results in NAs getting inserted into the abstract text.

library(microdemic)
library(jsonlite)

res <- ma_abstract("And(Composite(AA.AuN=='jaime teevan'),Y>2012)", key = Sys.getenv("MAG_KEY"))
res$abstract[grepl("\\bNA\\b", res$abstract)]
#> [1] "The queries people issue to a search engine and the results clicked following a query change over time. For example, after the earthquake in Japan in March 2011, the query NA japan NA spiked in popularity and people issuing the query were more likely to click government-related results than they would prior to the earthquake. We explore the modeling and prediction of such temporal patterns in Web search behavior. We develop a temporal modeling framework adapted from physics and signal processing and harness it to predict temporal patterns in search behavior using smoothing, trends, periodicities, and surprises. Using current and past behavioral data, we develop a learning procedure that can be used to construct models of users' Web search activities. We also develop a novel methodology that learns to select the best prediction model from a family of predictive models for a given query or a class of queries. Experimental results indicate that the predictive models significantly outperform baseline models that weight historical evidence the same for all queries. We present two applications where new methods introduced for the temporal modeling of user behavior significantly improve upon the state of the art. Finally, we discuss opportunities for using models of temporal dynamics to enhance other areas of Web search and information retrieval."
#> [2] "The physical constraints of smartwatches limit the range and complexity of tasks that can be completed. Despite interface improvements on smartwatches, the promise of enabling productive work remains largely unrealized. This paper presents NA WearWrite , a system that enables users to write documents from their smartwatches by leveraging a crowd to help translate their ideas into text. WearWrite users dictate tasks, respond to questions, and receive notifications of major edits on their watch. Using a dynamic task queue, the crowd receives tasks issued by the watch user and generic tasks from the system. In a week-long study with seven smartwatch users supported by approximately 29 crowd workers each, we validate that it is possible to manage the crowd writing process from a watch. Watch users captured new ideas as they came to mind and managed a crowd during spare moments while going about their daily routine. WearWrite represents a new approach to getting work done from wearables using the crowd."

Created on 2019-01-07 by the reprex package (v0.2.0.9000).

Session info

devtools::session_info()
#> Session info -------------------------------------------------------------
#>  setting  value                       
#>  version  R version 3.4.4 (2018-03-15)
#>  system   x86_64, linux-gnu           
#>  ui       X11                         
#>  language (EN)                        
#>  collate  en_US.UTF-8                 
#>  tz       America/New_York            
#>  date     2019-01-07
#> Packages -----------------------------------------------------------------
#>  package    * version date       source         
#>  backports    1.1.2   2017-12-13 cran (@1.1.2)  
#>  base       * 3.4.4   2018-03-16 local          
#>  compiler     3.4.4   2018-03-16 local          
#>  crul         0.7.0   2019-01-04 CRAN (R 3.4.4) 
#>  curl         3.2     2018-03-28 CRAN (R 3.4.4) 
#>  datasets   * 3.4.4   2018-03-16 local          
#>  devtools     1.13.6  2018-06-27 cran (@1.13.6) 
#>  digest       0.6.17  2018-09-12 cran (@0.6.17) 
#>  evaluate     0.10.1  2017-06-24 cran (@0.10.1) 
#>  graphics   * 3.4.4   2018-03-16 local          
#>  grDevices  * 3.4.4   2018-03-16 local          
#>  htmltools    0.3.6   2017-04-28 cran (@0.3.6)  
#>  httpcode     0.2.0   2016-11-14 CRAN (R 3.4.4) 
#>  jsonlite   * 1.5     2017-06-01 cran (@1.5)    
#>  knitr        1.20    2018-02-20 cran (@1.20)   
#>  magrittr     1.5     2014-11-22 cran (@1.5)    
#>  memoise      1.1.0   2017-04-21 CRAN (R 3.4.4) 
#>  methods    * 3.4.4   2018-03-16 local          
#>  microdemic * 0.4.0   2018-10-25 CRAN (R 3.4.4) 
#>  pillar       1.2.3   2018-05-25 cran (@1.2.3)  
#>  R6           2.2.2   2017-06-17 cran (@2.2.2)  
#>  Rcpp         0.12.18 2018-07-23 cran (@0.12.18)
#>  rlang        0.2.2   2018-08-16 cran (@0.2.2)  
#>  rmarkdown    1.10    2018-06-11 cran (@1.10)   
#>  rprojroot    1.3-2   2018-01-03 cran (@1.3-2)  
#>  stats      * 3.4.4   2018-03-16 local          
#>  stringi      1.2.4   2018-07-20 cran (@1.2.4)  
#>  stringr      1.3.1   2018-05-10 cran (@1.3.1)  
#>  tibble       1.4.2   2018-01-22 cran (@1.4.2)  
#>  tools        3.4.4   2018-03-16 local          
#>  triebeard    0.3.0   2016-08-04 CRAN (R 3.4.4) 
#>  urltools     1.7.1   2018-08-03 CRAN (R 3.4.4) 
#>  utils      * 3.4.4   2018-03-16 local          
#>  withr        2.1.2   2018-03-15 CRAN (R 3.4.4) 
#>  yaml         2.2.0   2018-07-25 cran (@2.2.0)

Happy to issue a PR for this.

evalulate route requires new parameter

model with values latest or beta-2015

Consider passing along detailed error messages to user

It would be nice if microdemic passed along the detailed error messages that the API provides, as opposed to just giving the HTTP error code. For example:

library(microdemic)
library(httr)

# here we only get the HTTP error code
ma_evaluate(
  query = "invalid-query", 
  key = Sys.getenv("MAG_KEY")
)
#> Error: Bad Request (HTTP 400)

# ...but the server provides more details on why this error occured:
out <- POST(
  'https://api.labs.cognitive.microsoft.com/academic/v1.0/evaluate',
  config = add_headers("Ocp-Apim-Subscription-Key" = Sys.getenv("MAG_KEY")),
  body = "expr=invalid-query"
)
content(out, "text")
#> No encoding supplied: defaulting to UTF-8.
#> [1] "{\"Error\":{\"Code\":\"Bad Argument\",\"Message\":\"Invalid query expression\\r\\nParameter name: expression\"}}"

Created on 2019-01-07 by the reprex package (v0.2.0.9000).

Session info

devtools::session_info()
#> Session info -------------------------------------------------------------
#>  setting  value                       
#>  version  R version 3.4.4 (2018-03-15)
#>  system   x86_64, linux-gnu           
#>  ui       X11                         
#>  language (EN)                        
#>  collate  en_US.UTF-8                 
#>  tz       America/New_York            
#>  date     2019-01-07
#> Packages -----------------------------------------------------------------
#>  package    * version date       source         
#>  backports    1.1.2   2017-12-13 cran (@1.1.2)  
#>  base       * 3.4.4   2018-03-16 local          
#>  compiler     3.4.4   2018-03-16 local          
#>  crul         0.7.0   2019-01-04 CRAN (R 3.4.4) 
#>  curl         3.2     2018-03-28 CRAN (R 3.4.4) 
#>  datasets   * 3.4.4   2018-03-16 local          
#>  devtools     1.13.6  2018-06-27 cran (@1.13.6) 
#>  digest       0.6.17  2018-09-12 cran (@0.6.17) 
#>  evaluate     0.10.1  2017-06-24 cran (@0.10.1) 
#>  graphics   * 3.4.4   2018-03-16 local          
#>  grDevices  * 3.4.4   2018-03-16 local          
#>  htmltools    0.3.6   2017-04-28 cran (@0.3.6)  
#>  httpcode     0.2.0   2016-11-14 CRAN (R 3.4.4) 
#>  httr       * 1.3.1   2017-08-20 CRAN (R 3.4.4) 
#>  knitr        1.20    2018-02-20 cran (@1.20)   
#>  magrittr     1.5     2014-11-22 cran (@1.5)    
#>  memoise      1.1.0   2017-04-21 CRAN (R 3.4.4) 
#>  methods    * 3.4.4   2018-03-16 local          
#>  microdemic * 0.4.0   2018-10-25 CRAN (R 3.4.4) 
#>  pillar       1.2.3   2018-05-25 cran (@1.2.3)  
#>  R6           2.2.2   2017-06-17 cran (@2.2.2)  
#>  Rcpp         0.12.18 2018-07-23 cran (@0.12.18)
#>  rlang        0.2.2   2018-08-16 cran (@0.2.2)  
#>  rmarkdown    1.10    2018-06-11 cran (@1.10)   
#>  rprojroot    1.3-2   2018-01-03 cran (@1.3-2)  
#>  stats      * 3.4.4   2018-03-16 local          
#>  stringi      1.2.4   2018-07-20 cran (@1.2.4)  
#>  stringr      1.3.1   2018-05-10 cran (@1.3.1)  
#>  tibble       1.4.2   2018-01-22 cran (@1.4.2)  
#>  tools        3.4.4   2018-03-16 local          
#>  triebeard    0.3.0   2016-08-04 CRAN (R 3.4.4) 
#>  urltools     1.7.1   2018-08-03 CRAN (R 3.4.4) 
#>  utils      * 3.4.4   2018-03-16 local          
#>  withr        2.1.2   2018-03-15 CRAN (R 3.4.4) 
#>  yaml         2.2.0   2018-07-25 cran (@2.2.0)

Happy to create a PR for this if you're interested.

Retrieving multiple entities

Trying to retrieve multiple entities by using

ma_evaluate(query = "Id = [2140699752, 2042123098]")
returns error:

for a single entity works fine