From 62fa2a3764adab41a860dbffa1b6a4e22bd9a6a7 Mon Sep 17 00:00:00 2001 From: Emanuele Guidotti Date: Wed, 21 Aug 2024 11:09:31 +0000 Subject: [PATCH] Built site for RblDataLicense@0.2.6: 8d925dd --- 404.html | 16 +++---- LICENSE-text.html | 18 ++++---- articles/RblDataLicense.html | 25 +++++------ articles/index.html | 16 +++---- authors.html | 22 +++++----- index.html | 16 +++---- news/index.html | 18 ++++---- pkgdown.yml | 7 ++-- reference/RblConnect.html | 50 +++++++++++----------- reference/RblDownload.html | 38 ++++++++--------- reference/RblFiles.html | 26 ++++++------ reference/RblParse.html | 33 ++++++++------- reference/RblQuery.html | 58 ++++++++++++------------- reference/RblRequestBuilder.html | 36 ++++++++-------- reference/RblUpload.html | 36 ++++++++-------- reference/RblUrl.html | 26 ++++++------ reference/RblUser.html | 26 ++++++------ reference/index.html | 16 +++---- sitemap.xml | 72 +++++++++----------------------- 19 files changed, 256 insertions(+), 299 deletions(-) diff --git a/404.html b/404.html index 910a229..0dc9552 100644 --- a/404.html +++ b/404.html @@ -6,7 +6,7 @@ Page not found (404) • RblDataLicense - + @@ -18,7 +18,7 @@ - +
@@ -49,7 +49,7 @@
  • - +
    • @@ -60,7 +60,7 @@
    - +
    @@ -88,16 +88,16 @@

    Page not found (404)

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/LICENSE-text.html b/LICENSE-text.html index e06692a..fb5339d 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -1,9 +1,9 @@ -License • RblDataLicenseLicense • RblDataLicense - +
    @@ -31,14 +31,14 @@
    - +
    @@ -47,7 +47,7 @@

    License

                        GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007 
+                       Version 3, 29 June 2007
 
  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
@@ -737,15 +737,15 @@ 
    License
    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/articles/RblDataLicense.html b/articles/RblDataLicense.html index cebb6a1..59a7eb3 100644 --- a/articles/RblDataLicense.html +++ b/articles/RblDataLicense.html @@ -6,20 +6,19 @@ Connecting R to Bloomberg Data License • RblDataLicense - + - - +
    @@ -50,7 +49,7 @@
  • - +
    • @@ -61,7 +60,7 @@
    - +
    @@ -70,9 +69,9 @@

    Connecting R to Bloomberg Data License

    Emanuele Guidotti

    -

    2023-10-13

    +

    2024-08-21

    - Source: vignettes/RblDataLicense.Rmd + Source: vignettes/RblDataLicense.Rmd
    @@ -205,9 +204,7 @@

    Disclaimer - -

    + @@ -220,16 +217,16 @@

    Disclaimer

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/articles/index.html b/articles/index.html index 977f696..3580e82 100644 --- a/articles/index.html +++ b/articles/index.html @@ -1,9 +1,9 @@ -Articles • RblDataLicenseArticles • RblDataLicense - +
    @@ -31,14 +31,14 @@
    - +
    @@ -62,15 +62,15 @@

    All vignettes

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/authors.html b/authors.html index 2ab8f35..1937f4d 100644 --- a/authors.html +++ b/authors.html @@ -1,9 +1,9 @@ -Authors and Citation • RblDataLicenseAuthors and Citation • RblDataLicense - +
    @@ -31,23 +31,23 @@
    - +
    -

    Authors

    +

    Authors and Citation

    - +
    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/index.html b/index.html index 13f57e4..20e258f 100644 --- a/index.html +++ b/index.html @@ -6,7 +6,7 @@ R Interface to Bloomberg Data License • RblDataLicense - + @@ -19,7 +19,7 @@ - +
    @@ -50,7 +50,7 @@
  • - +
    • @@ -61,7 +61,7 @@
    - +
    @@ -199,16 +199,16 @@

    Dev status

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/news/index.html b/news/index.html index f4fa38f..a8ef481 100644 --- a/news/index.html +++ b/news/index.html @@ -1,9 +1,9 @@ -Changelog • RblDataLicenseChangelog • RblDataLicense - +
    @@ -31,20 +31,20 @@
    - +

    Changelog

    - Source: NEWS.md + Source: NEWS.md
    @@ -97,15 +97,15 @@

    RblDataLic

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/pkgdown.yml b/pkgdown.yml index 6f15493..8adc264 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -1,10 +1,9 @@ -pandoc: 2.19.2 -pkgdown: 2.0.7 +pandoc: 3.1.11 +pkgdown: 2.1.0 pkgdown_sha: ~ articles: RblDataLicense: RblDataLicense.html -last_built: 2023-10-13T10:06Z +last_built: 2024-08-21T11:09Z urls: reference: https://rbldatalicense.eguidotti.com/reference article: https://rbldatalicense.eguidotti.com/articles - diff --git a/reference/RblConnect.html b/reference/RblConnect.html index 0f7c22f..cbb76a6 100644 --- a/reference/RblConnect.html +++ b/reference/RblConnect.html @@ -1,12 +1,12 @@ -Create an SFTP connection to Bloomberg Data License — RblConnect • RblDataLicenseCreate an SFTP connection to Bloomberg Data License — RblConnect • RblDataLicense - +
    @@ -34,27 +34,27 @@
    - +

    Create an SFTP connection to Bloomberg Data License

    - Source: R/core.R + Source: R/core.R

    An sftp connection to Bloomberg Datalicense is established. On some Linux systems, this may -not work out of the box, as libcurl does not natively support sftp. In that case, you need to -compile curl with SFTP support. +not work out of the box, as libcurl does not natively support sftp. In that case, you need to +compile curl with SFTP support. See here for details: http://askubuntu.com/questions/195545/how-to-enable-sftp-support-in-curl

    @@ -71,43 +71,43 @@

    Create an SFTP connection to Bloomberg Data License

    Arguments

    -
    user
    + + +
    user

    The account number assigned by Bloomberg

    -
    pw
    +
    pw

    The password assigned by Bloomberg

    -
    host
    +
    host

    The connection host

    -
    port
    +
    port

    The connection port

    -
    protocol
    +
    protocol

    The connection protocol

    -
    verbose
    -

    logical. Should R report extra information on progress?

    +
    verbose
    +

    logical. Should print extra information on failure?

    Value

    - - -

    logical. Is the connection succesful?

    +

    logical. Is the connection succesful?

    Examples

    - 
    if (FALSE) {
+    
    if (FALSE) { # \dontrun{
 # These are dummy credentials. Replace with the credentials received from Bloomberg 
 RblConnect(user = 'dl000000', pw = '0000000000000000') 
-}
+} # }
    @@ -123,15 +123,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/RblDownload.html b/reference/RblDownload.html index 22c7dad..de49019 100644 --- a/reference/RblDownload.html +++ b/reference/RblDownload.html @@ -1,11 +1,11 @@ -Download a file from Bloomberg — RblDownload • RblDataLicenseDownload a file from Bloomberg — RblDownload • RblDataLicense - +
    @@ -33,25 +33,25 @@
    - +

    Download a file from Bloomberg

    - Source: R/core.R + Source: R/core.R
    -

    Download a generic file from Bloomberg. +

    Download a generic file from Bloomberg. Use RblFiles to list the files available at Bloomberg. If the file is not available yet (i.e. a request file has just been uploaded), the function waits until the response file is there or the timeout is reached

    @@ -62,32 +62,32 @@

    Download a file from Bloomberg

    Arguments

    -
    file
    + + +
    file

    character string representing the file to download

    -
    frequency
    +
    frequency

    the polling frequency to check if file is available at Bloomberg

    -
    timeout
    +
    timeout

    the timeout in seconds

    -
    verbose
    +
    verbose

    logical. Should R report extra information on progress?

    Value

    - - -

    character string. Path to the downloaded file. NULL on failure

    +

    character string. Path to the downloaded file. NULL on failure

    Examples

    - 
    if (FALSE) {
+    
    if (FALSE) { # \dontrun{
 # Run RblConnect first
 
 # Build a request file to download the daily closing prices of 
@@ -107,7 +107,7 @@ 
    Examples
    
 # Download the response file
 out <- RblDownload(req$out)
 out
-}
+} # }
    @@ -123,15 +123,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/RblFiles.html b/reference/RblFiles.html index 47861b6..4535373 100644 --- a/reference/RblFiles.html +++ b/reference/RblFiles.html @@ -1,9 +1,9 @@ -List files available at Bloomberg — RblFiles • RblDataLicenseList files available at Bloomberg — RblFiles • RblDataLicense - +
    @@ -31,20 +31,20 @@
    - +

    List files available at Bloomberg

    - Source: R/core.R + Source: R/core.R
    @@ -58,17 +58,15 @@

    List files available at Bloomberg

    Value

    - - -

    Vector of character strings representing the filenames available at Bloomberg

    +

    Vector of character strings representing the filenames available at Bloomberg

    Examples

    - 
    if (FALSE) {
+    
    if (FALSE) { # \dontrun{
 # Run RblConnect first
 RblFiles()
-}
+} # }
    @@ -84,15 +82,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/RblParse.html b/reference/RblParse.html index 1f32a7c..a782f65 100644 --- a/reference/RblParse.html +++ b/reference/RblParse.html @@ -1,9 +1,9 @@ -Parse Bloomberg response file and import data — RblParse • RblDataLicenseParse Bloomberg response file and import data — RblParse • RblDataLicense - +
    @@ -31,20 +31,20 @@
    - +

    Parse Bloomberg response file and import data

    - Source: R/core.R + Source: R/core.R
    @@ -58,25 +58,26 @@

    Parse Bloomberg response file and import data

    Arguments

    -
    file
    + + +
    file

    character string representing the local file to parse (see RblDownload)

    -
    auto.assign
    +
    auto.assign

    logical. Should results be loaded to env when using PROGRAMNAME=gethistory?

    -
    env
    +
    env

    where to create objects if auto.assign = TRUE

    -
    verbose
    +
    verbose

    logical. Should R report extra information on progress?

    Value

    -
    PROGRAMNAME=getdata

    data.frame containing identifiers (rows) and fields (columns). NULL on failure.

    @@ -89,7 +90,7 @@

    Value

    Examples

    - 
    if (FALSE) {
+    
    if (FALSE) { # \dontrun{
 # Run RblConnect first
 
 # Build a request file to download the daily closing prices of 
@@ -112,7 +113,7 @@ 
    Examples
    
 # Import the data
 data <- RblParse(out)
 str(data)
-}
+} # }
    @@ -128,15 +129,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/RblQuery.html b/reference/RblQuery.html index febef87..b049a13 100644 --- a/reference/RblQuery.html +++ b/reference/RblQuery.html @@ -1,9 +1,9 @@ -Query Bloomberg and Fetch Data — RblQuery • RblDataLicenseQuery Bloomberg and Fetch Data — RblQuery • RblDataLicense - +
    @@ -31,20 +31,20 @@
    - +

    Query Bloomberg and Fetch Data

    - Source: R/RblQuery.R + Source: R/RblQuery.R
    @@ -74,71 +74,71 @@

    Query Bloomberg and Fetch Data

    Arguments

    -
    identifiers
    + + +
    identifiers

    vector of Bloomberg identifiers. E.g. c('SXXE Index', 'SX5E Index')

    -
    fields
    +
    fields

    vector of Bloomberg fields. E.g. c('PX_LAST', 'PX_CLOSE', 'PX_OPEN', 'PX_HIGH', 'PX_LOW')

    -
    from
    +
    from

    date or string (format YYYY-MM-DD). Start time for the 'gethistory' request. If not provided, a 'getdata' request will be made

    -
    to
    +
    to

    date or string (format YYYY-MM-DD). End time for the 'gethistory' request. Ignored if from is not provided

    -
    auto.assign
    +
    auto.assign

    logical. Should results be loaded to env? Ignored if from is not provided

    -
    env
    +
    env

    where to create objects if auto.assign = TRUE

    -
    category
    +
    category

    vector of Data License categories to enable. E.g. c('SECMASTER', 'PRICING', 'FUNDAMENTALS'). WARNING! Each DL category is billed separately, so check your DL license carefully!

    -
    add_headers
    +
    add_headers

    named vector of additional headers. E.g. c(PROGRAMFLAG = 'oneshot')

    -
    overrides
    +
    overrides

    named vector of Bloomberg overrides. E.g. c('END_DT' = '20100101')

    -
    limit
    +
    limit

    prevent requesting data for more than this amout of identifiers. This is done to help you keeping your budget under control. Data License is billing based on the amout of instruments you request, so check your DL license carefully before increasing this limit.

    -
    split
    +
    split

    maximum number of identifiers to process at once. Requests are split to avoid memory leaks.

    -
    frequency
    +
    frequency

    the polling frequency to check if the response file is available at Bloomberg

    -
    timeout
    +
    timeout

    the timeout in seconds

    -
    filename
    +
    filename

    name assigned to the remote file. Only alphanumeric characters are allowed. Invalid characters are removed.

    -
    verbose
    +
    verbose

    logical. Should R report extra information on progress?

    Value

    - - -

    A list with components

    req
    +

    A list with components

    req

    List of characters representing each of the request files uploaded to Bloomberg

    out
    @@ -168,13 +168,13 @@

    Details

    Examples

    - 
    if (FALSE) {
+    
    if (FALSE) { # \dontrun{
 # Run RblConnect first
 data <- RblQuery(fields = c('PX_LAST', 'PX_OPEN', 'PX_HIGH', 'PX_LOW'), 
                  identifiers = c('SXXE Index', "SX5E Index"), 
                  from = '2005-01-01')
 str(data)
-}
+} # }
    @@ -190,15 +190,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/RblRequestBuilder.html b/reference/RblRequestBuilder.html index 42187c8..f6e8eb9 100644 --- a/reference/RblRequestBuilder.html +++ b/reference/RblRequestBuilder.html @@ -1,10 +1,10 @@ -Build a request file to query Bloomberg — RblRequestBuilder • RblDataLicenseBuild a request file to query Bloomberg — RblRequestBuilder • RblDataLicense - +
    @@ -32,20 +32,20 @@
    - +

    Build a request file to query Bloomberg

    - Source: R/core.R + Source: R/core.R
    @@ -60,32 +60,32 @@

    Build a request file to query Bloomberg

    Arguments

    -
    header
    + + +
    header

    named vector of headers. E.g. c(FIRMNAME = RblUser(), PROGRAMNAME = 'getdata')

    -
    fields
    +
    fields

    vector of Bloomberg fields. E.g. c('PX_LAST', 'PX_OPEN', 'PX_HIGH', 'PX_LOW')

    -
    identifiers
    +
    identifiers

    vector of Bloomberg identifiers. E.g. c('SXXE Index', 'SX5E Index')

    -
    overrides
    +
    overrides

    named vector of Bloomberg overrides. E.g. c('END_DT' = '20100101')

    Value

    - - -

    character string representing the request file. Upload it to query Bloomberg (see RblUpload)

    +

    character string representing the request file. Upload it to query Bloomberg (see RblUpload)

    Examples

    - 
    if (FALSE) {
+    
    if (FALSE) { # \dontrun{
 # Run RblConnect first
 
 # Build a request file to download the daily closing prices of 
@@ -99,7 +99,7 @@ 
    Examples
    
           identifiers = c('SXXE Index')
      )
 RblRequest
-}
+} # }
    @@ -115,15 +115,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/RblUpload.html b/reference/RblUpload.html index 637f653..85c7373 100644 --- a/reference/RblUpload.html +++ b/reference/RblUpload.html @@ -1,11 +1,11 @@ -Upload a request file to Bloomberg — RblUpload • RblDataLicenseUpload a request file to Bloomberg — RblUpload • RblDataLicense - +
    @@ -33,25 +33,25 @@
    - +

    Upload a request file to Bloomberg

    - Source: R/core.R + Source: R/core.R
    -

    Upload a request file to query Bloomberg. A response file will be generated by Bloomberg. +

    Upload a request file to query Bloomberg. A response file will be generated by Bloomberg. The request file can be user-defined following the Bloomberg Data License documentation or generated with the RblRequestBuilder function. The response file needs to be downloaded (see RblDownload) and parsed (see RblParse) to import the data in R.

    @@ -66,23 +66,23 @@

    Upload a request file to Bloomberg

    Arguments

    -
    RblRequest
    + + +
    RblRequest

    character string representing the request file according to Bloomberg Datalicense documentation. Can be generated with the RblRequestBuilder function

    -
    filename
    +
    filename

    name assigned to the remote file. Only alphanumeric characters and underscores are allowed. Invalid characters are removed.

    -
    verbose
    +
    verbose

    logical. Should R report extra information on progress?

    Value

    - - -

    A list with components

    req
    +

    A list with components

    req

    the request filename

    out
    @@ -93,7 +93,7 @@

    Value

    Examples

    - 
    if (FALSE) {
+    
    if (FALSE) { # \dontrun{
 # Run RblConnect first
 
 # Build a request file to download the daily closing prices of 
@@ -110,7 +110,7 @@ 
    Examples
    
 # Upload the request file
 req <- RblUpload(RblRequest)
 req
-}
+} # }
    @@ -126,15 +126,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/RblUrl.html b/reference/RblUrl.html index 1d19fed..d533768 100644 --- a/reference/RblUrl.html +++ b/reference/RblUrl.html @@ -1,9 +1,9 @@ -Get Bloomberg connection Url — RblUrl • RblDataLicenseGet Bloomberg connection Url — RblUrl • RblDataLicense - +
    @@ -31,20 +31,20 @@
    - +

    Get Bloomberg connection Url

    - Source: R/core.R + Source: R/core.R
    @@ -58,17 +58,15 @@

    Get Bloomberg connection Url

    Value

    - - -

    Url string

    +

    Url string

    Examples

    - 
    if (FALSE) {
+    
    if (FALSE) { # \dontrun{
 # Run RblConnect first
 RblUrl()
-}
+} # }
    @@ -84,15 +82,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/RblUser.html b/reference/RblUser.html index 910facb..c2e423f 100644 --- a/reference/RblUser.html +++ b/reference/RblUser.html @@ -1,9 +1,9 @@ -Get Bloomberg User — RblUser • RblDataLicenseGet Bloomberg User — RblUser • RblDataLicense - +
    @@ -31,20 +31,20 @@
    - +

    Get Bloomberg User

    - Source: R/core.R + Source: R/core.R
    @@ -58,17 +58,15 @@

    Get Bloomberg User

    Value

    - - -

    User string

    +

    User string

    Examples

    - 
    if (FALSE) {
+    
    if (FALSE) { # \dontrun{
 # Run RblConnect first
 RblUser()
-}
+} # }
    @@ -84,15 +82,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/index.html b/reference/index.html index f66e889..83b25b1 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,9 +1,9 @@ -Function reference • RblDataLicensePackage index • RblDataLicense - +
    @@ -31,14 +31,14 @@
    - +
    @@ -99,15 +99,15 @@

    All functions
    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/sitemap.xml b/sitemap.xml index d65832a..dcf2863 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1,54 +1,20 @@ - - - - https://rbldatalicense.eguidotti.com/404.html - - - https://rbldatalicense.eguidotti.com/LICENSE-text.html - - - https://rbldatalicense.eguidotti.com/articles/RblDataLicense.html - - - https://rbldatalicense.eguidotti.com/articles/index.html - - - https://rbldatalicense.eguidotti.com/authors.html - - - https://rbldatalicense.eguidotti.com/index.html - - - https://rbldatalicense.eguidotti.com/news/index.html - - - https://rbldatalicense.eguidotti.com/reference/RblConnect.html - - - https://rbldatalicense.eguidotti.com/reference/RblDownload.html - - - https://rbldatalicense.eguidotti.com/reference/RblFiles.html - - - https://rbldatalicense.eguidotti.com/reference/RblParse.html - - - https://rbldatalicense.eguidotti.com/reference/RblQuery.html - - - https://rbldatalicense.eguidotti.com/reference/RblRequestBuilder.html - - - https://rbldatalicense.eguidotti.com/reference/RblUpload.html - - - https://rbldatalicense.eguidotti.com/reference/RblUrl.html - - - https://rbldatalicense.eguidotti.com/reference/RblUser.html - - - https://rbldatalicense.eguidotti.com/reference/index.html - + +https://rbldatalicense.eguidotti.com/404.html +https://rbldatalicense.eguidotti.com/LICENSE-text.html +https://rbldatalicense.eguidotti.com/articles/RblDataLicense.html +https://rbldatalicense.eguidotti.com/articles/index.html +https://rbldatalicense.eguidotti.com/authors.html +https://rbldatalicense.eguidotti.com/index.html +https://rbldatalicense.eguidotti.com/news/index.html +https://rbldatalicense.eguidotti.com/reference/RblConnect.html +https://rbldatalicense.eguidotti.com/reference/RblDownload.html +https://rbldatalicense.eguidotti.com/reference/RblFiles.html +https://rbldatalicense.eguidotti.com/reference/RblParse.html +https://rbldatalicense.eguidotti.com/reference/RblQuery.html +https://rbldatalicense.eguidotti.com/reference/RblRequestBuilder.html +https://rbldatalicense.eguidotti.com/reference/RblUpload.html +https://rbldatalicense.eguidotti.com/reference/RblUrl.html +https://rbldatalicense.eguidotti.com/reference/RblUser.html +https://rbldatalicense.eguidotti.com/reference/index.html +