Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(R-SDK) : Fixed CRAN Review Comments #21

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions r/factset.protobuf.stach.v2/DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Package: factset.protobuf.stach.v2
Type: Package
Version: 1.0.6
Title: 'FactSet' 'STACH V2' Library
Version: 1.0.3
Author: analytics-reporting
Maintainer: Charlie Mathis<[email protected]>
Authors@R:
person("Charlie Mathis", role = c("aut","cre"), email = "[email protected]")
Description: Generates 'RProtobuf' classes for 'FactSet' 'STACH V2' tabular
format which represents complex multi-dimensional array of data. These
classes help in the 'serialization' and 'deserialization' of 'STACH V2'
Expand All @@ -14,8 +14,10 @@ BugReports: https://github.com/factset/stachschema-sdks/issues
License: Apache License 2.0
Encoding: UTF-8
LazyData: true
Imports: R6
Depends: RProtoBuf
Imports:
R6
Depends:
RProtoBuf
Suggests: testthat
SystemRequirements: ProtoBuf libraries and compiler version 3.3.0 or later;
On Debian/Ubuntu these can be installed as libprotoc-dev, libprotobuf-dev
Expand Down
Binary file not shown.
Binary file not shown.
14 changes: 12 additions & 2 deletions r/factset.protobuf.stach.v2/man/factset.protobuf.stach.v2.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The purpose of this library is to help in the serialization and de-serialization
\describe{
\item{\code{package}}{Stach Data which is represented as a Package object}
\item{\code{input}}{Input file which is in binary format}
}
}\if{html}{\out{</div>}}
}

\examples{
Expand All @@ -26,8 +26,18 @@ read( factset.protobuf.stach.v2.Package, input = 'path of your stach file' )
# an example to Read row organized file data from a connection
read( factset.protobuf.stach.v2.RowOrganizedPackage, input = 'path of your stach file' )

# an example to Read the raw stach data as a character
# an example to Read the raw stach data as a character
read( factset.protobuf.stach.v2.Package, input = as.character(stachdata) )
}
\testonly{
# an example to Read column organized file data from a connection
binaryFilePath <-
system.file('testdata/V2ColumnStachData', package = 'factset.protobuf.stach.v2')
package <- read( factset.protobuf.stach.v2.Package, input = binaryFilePath )

# an example to Read row organized file data from a connection
binaryFilePath <-
system.file('testdata/V2RowStachData', package = 'factset.protobuf.stach.v2')
package <- read( factset.protobuf.stach.v2.RowOrganizedPackage, input = binaryFilePath )
}
}