diff --git a/README.rst b/README.rst index 8b1c1b7..05247d6 100644 --- a/README.rst +++ b/README.rst @@ -18,7 +18,7 @@ Its main advantages are: - It is a pure Python implementation, with no dependencies on the R language or related libraries. Thus, it can be used anywhere where Python is supported, including the web - using `Pyodide `_. + using `Pyodide `__. - It attempt to support all R objects that can be meaningfully translated. As opposed to other solutions, you are no limited to import dataframes or data with a particular structure. @@ -101,14 +101,14 @@ Under the hood, this is equivalent to the following code: This consists on two steps: #. First, the file is parsed using the function - `rdata.parser.parse_file `_. + `rdata.parser.parse_file `__. This provides a literal description of the file contents as a hierarchy of Python objects representing the basic R objects. This step is unambiguous and always the same. #. Then, each object must be converted to an appropriate Python object. In this step there are several choices on which Python type is the most appropriate as the conversion for a given R object. Thus, we provide a default - `rdata.conversion.convert `_ + `rdata.conversion.convert `__ routine, which tries to select Python objects that preserve most information of the original R object. For custom R classes, it is also possible to specify conversion routines to Python objects. @@ -117,40 +117,40 @@ Convert custom R classes ------------------------ The basic -`convert `_ +`convert `__ routine only constructs a -`SimpleConverter `_ +`SimpleConverter `__ object and calls its -`convert `_ +`convert `__ method. All arguments of -`convert `_ +`convert `__ are directly passed to the -`SimpleConverter `_ +`SimpleConverter `__ initialization method. It is possible, although not trivial, to make a custom -`Converter `_ +`Converter `__ object to change the way in which the basic R objects are transformed to Python objects. However, a more common situation is that one does not want to change how basic R objects are converted, but instead wants to provide conversions for specific R classes. This can be done by passing a dictionary to the -`SimpleConverter `_ +`SimpleConverter `__ initialization method, containing as keys the names of R classes and as values, callables that convert a R object of that class to a Python object. By default, the dictionary used is -`DEFAULT_CLASS_MAP `_, +`DEFAULT_CLASS_MAP `__, which can convert commonly used R classes such as -`data.frame `_ -and `factor `_. +`data.frame `__ +and `factor `__. As an example, here is how we would implement a conversion routine for the factor class to -`bytes `_ +`bytes `__ objects, instead of the default conversion to Pandas -`Categorical `_ objects: +`Categorical `__ objects: .. code:: python @@ -187,7 +187,7 @@ Additional examples Additional examples illustrating the functionalities of this package can be found in the -`ReadTheDocs documentation `_. +`ReadTheDocs documentation `__. .. |build-status| image:: https://github.com/vnmabus/rdata/actions/workflows/main.yml/badge.svg?branch=master diff --git a/rdata/__init__.py b/rdata/__init__.py index b5cae67..44616d7 100644 --- a/rdata/__init__.py +++ b/rdata/__init__.py @@ -21,4 +21,4 @@ def _get_test_data_path() -> Traversable: """ -__version__ = "0.11.1" +__version__ = "0.11.2"