easyPubMed-class: Class easyPubMed.

easyPubMed-classR Documentation

Class easyPubMed.

Description

Class easyPubMed defines objects that represent PubMed Query jobs and the corresponding results. Briefly, these objects are initialized using information that will guide the communication with the NCBI Entrez server. Also, easyPubMed objects are used to store raw and processed data retrieved from Pubmed.

Usage

## S4 method for signature 'easyPubMed'
initialize(.Object, query_string, job_info)

Arguments

.Object

The easyPubMed object being built.

query_string

String (character vector of length 1) corresponding to the user-provided text of the query to be submitted to PubMed.

job_info

List, this should be the output of 'EPM_job_split()'.

Slots

query

String (character vector of length 1) corresponding to the PubMed request submitted by the user.

meta

List including meta information about the PubMed Query job.

uilist

List including all unique identifiers corresponding to the Pubmed records returned by the query. Can be empty.

raw

List including the raw data (in 'xml' or 'medline' format) retrieved from the NCBI eFetch server. Can be empty.

data

Data.frame including processed data based on the xml raw data retrieved from PubMed.

misc

List including additional information.

Author(s)

Damiano Fantini damiano.fantini@gmail.com


dami82/easyPubMed documentation built on Jan. 4, 2024, 6:21 a.m.